Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions target_chains/solana/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

This folder contains:

- A Pyth receiver program to receive Pyth price updates on Solana in `programs/pyth-solana-receiver`
- A Cli that acts as a simple client to interact with the Pyth receiver program in `cli/`
- A Pyth Receiver program to receive Pyth price updates on Solana in [`programs/pyth-solana-receiver`](/target_chains/solana/programs/pyth-solana-receiver)
- A Rust SDK to be used in Solana programs to consume Pyth price updates posted by the Pyth Receiver in [`pyth_solana_receiver_sdk`](/target_chains/solana/pyth_solana_receiver_sdk)
- A JS SDK to be used in client side Javascript code to interact with the Pyth Receiver program in [`sdk/js/pyth_solana_receiver`](/target_chains/solana/sdk/js/pyth_solana_receiver/)

# Overview of the design

Expand All @@ -22,9 +23,9 @@ This contract offers two ways to post a Pyth price update onto Solana:
`post_update` is also a more efficient way to post updates if you're looking to post data for many different price feeds at a single point in time.
This is because it persists a verified encoded VAA, so guardian signatures will only get checked once. Then that single posted VAA can be used to prove the price update for all price feeds for that given point in time.

# Devnet deployment
# Program addresses

The program is currently deployed on Devnet and Eclipse Testnet with addresses:
The program is currently deployed on Solana (Mainnet, Devnet) and Eclipse Testnet with addresses:

- `HDwcJBJXjL9FpJ7UBsYBtaDjsBUhuLCUYoz3zr8SWWaQ` for the Wormhole receiver
- `rec5EKMGg6MxZYaMdyBfgwp4d5rB9T1VQH5pJv5LtFJ` for the Pyth receiver
Expand Down
58 changes: 58 additions & 0 deletions target_chains/solana/pyth_solana_receiver_sdk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Pyth Solana Receiver Rust SDK

This is a Rust SDK to build Solana programs that consume Pyth price updates posted by the Pyth Solana Receiver.

It is available on [crates.io](https://crates.io/crates/pyth-solana-receiver-sdk).

## Pull model

The Pyth Solana Receiver allows users to consume Pyth price updates on a pull basis. This means that the user is responsible for submitting the price data on-chain whenever they want to interact with an app that requires a price update.

Price updates get posted into price update accounts, owned by the Receiver contract. Once an update has been posted to a price update account, it can be used by anyone by simply passing the price update account as one of the accounts in a Solana instruction.
Price update accounts can be closed by whoever wrote them to recover the rent.

## Warning

When using price update accounts, you should check that the accounts are owned by the Pyth Solana Receiver contract to avoid impersonation attacks. This SDK checks this if you use Anchor's `Account` struct (ex: `Account<'info, PriceUpdateV2>`).

You should also check the `verification_level` of the account. Read more about this [here](/target_chains/solana/pyth_solana_receiver_sdk/src/price_update.rs) in the documentation for `VerificationLevel`.

## Example use

A Solana program can consume price update accounts created by the Pyth Solana Receiver using this SDK:

```rust
use anchor_lang::prelude::*;
use pyth_solana_receiver_sdk::price_update::{get_feed_id_from_hex, PriceUpdateV2};

declare_id!("2e5gZD3suxgJgkCg4pkoogxDKszy1SAwokz8mNeZUj4M");

pub const MAXIMUM_AGE: u64 = 60; // One minute
pub const FEED_ID: &str = "0xef0d8b6fda2ceba41da15d4095d1da392a0d2f8ed0c6c7bc0f4cfac8c280b56d"; // SOL/USD price feed id from https://pyth.network/developers/price-feed-ids

#[program]
pub mod my_first_pyth_app {
use super::*;

pub fn initialize(ctx: Context<Initialize>) -> Result<()> {
let price_update = &mut ctx.accounts.price_update;
let price = price_update.get_price_no_older_than(
&Clock::get()?,
MAXIMUM_AGE,
&get_feed_id_from_hex(FEED_ID)?,
)?;
/// Do something with the price
Ok(())
}
}

#[derive(Accounts)]
pub struct Initialize<'info> {
#[account(mut)]
pub payer: Signer<'info>,
pub price_update: Account<'info, PriceUpdateV2>,
// Add more accounts here
}


```
2 changes: 2 additions & 0 deletions target_chains/solana/sdk/js/pyth_solana_receiver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This is a Javascript SDK to interact with the Pyth Solana Receiver contract whose code lives [here](/target_chains/solana).

It is available on [npm](https://www.npmjs.com/package/@pythnetwork/pyth-solana-receiver).

## Pull model

The Pyth Solana Receiver allows users to consume Pyth price updates on a pull basis. This means that the user is responsible for submitting the price data on-chain whenever they want to interact with an app that requires a price update.
Expand Down