pyth-crosschain/target_chains/sui/README.md

Pyth on Sui

1. Background

Pyth price feeds on Sui are uniquely represented in the global store as PriceInfoObjects. These objects have the key ability and serve as wrappers around the PriceInfo object, which in turn wraps around the PriceFeed, the arrival time of the latest price update, and the attestation time of the latest update.

PriceInfoObjects are central to Pyth on Sui, since they are in unique correspondence with each Pyth price feed and must be passed in to functions that act on price feeds, e.g.

• update_price_feeds
• update_price_feed_from_single_vaa
• update_price_feeds_if_fresh

2. How to Update and Consume Price Feeds

To update and then consume a price feed, one needs to build a Sui programmable transaction.

As with other chains, one first obtains a batch price attestation VAA (of type vector<u8>) off-chain for a Price Info Object whose feed is to be used. Assume the ID is PRICE_INFO_OBJECT_ID. Then, chain together the following sequence of function calls:

1. wormhole::parse_and_verify

Call parse_and_verify on the batch attestation VAA bytes to obtain a VAA hot potato object.

public fun parse_and_verify(
      wormhole_state: &State,
      buf: vector<u8>,
      the_clock: &Clock
  ): VAA

2.pyth:update_price_feeds

Vectorize the VAA from the previous step and pass it to update_price_feeds.

 public fun update_price_feeds(
        pyth_state: &PythState,
        verified_vaas: vector<VAA>,
        price_info_objects: &mut vector<PriceInfoObject>,
        fee: Coin<SUI>,
        clock: &Clock
    )

3. pyth::get_price

Finally, get the price of the updated price feed in PriceInfoObject.

public fun get_price(
      state: &PythState,
      price_info_object: &PriceInfoObject,
      clock: &Clock
): Price

Fetch the price of the updated Price Info Object.

3. Examples

See the ./scripts folder for examples of programmable transactions for creating price feeds, updating price feeds, and deploying contracts.

To build and test the contracts, run the following

$ make test
$ make build

4. Contracts Registry

Pyth on Testnet

• PYTH_PACKAGE_ID: 0x7c017b047a3c9db5a8f4586d347c54869b761b6d6b0882a179823e8642faf7b9
• PYTH_STATE_ID: 0x3fc17e66d5ced3bf62f3fe8289cb2cb78c311a1e1c9700727ecd278d242e9e88

Wormhole on Testnet

• WORMHOLE_PACKAGE_ID: 0x80c60bff35fe5026e319cf3d66ae671f2b4e12923c92c45df75eaf4de79e3ce7
• WORMHOLE_STATE_ID: 0x79ab4d569f7eb1efdcc1f25b532f8593cda84776206772e33b490694cb8fc07a

Pyth on Mainnet

• PYTH_PACKAGE_ID: 0xa446c4a37c0bb69d03357c1a52d60da0b434048226d5f3feffdb693586bea861
• PYTH_STATE_ID: 0x428b5795904d5256d1eea5991df672934315fb8dcf8f6111134c1a52afd005ca

Wormhole on Mainnet

• WORMHOLE_PACKAGE_ID: 0x5306f64e312b581766351c07af79c72fcb1cd25147157fdc2f8ad76de9a3fb6a
• WORMHOLE_STATE_ID: 0xaeab97f96cf9877fee2883315d459552b2b921edc16d7ceac6eab944dd88919c