Merge branch 'sui_docs' of github.com:pyth-network/documentation into sui_docs

Author: optke3

pages/sui/index.mdx

@@ -1,13 +1,13 @@
-The Pyth Network Aptos contract allows users to submit price updates for verification and store them for later use.
+The Pyth Network Sui contract allows users to submit price updates for verification and store them for later use.
 Please see the documentation section on [Pull Updates](documentation/pythnet-price-feeds/on-demand) if you haven't already;
-this section will explain the differences between Pyth Network and other oracles, and help you understand the expected usage patterns.
+this section will explain the differences between Pyth Network and other oracles, and help you understand the expected usage patterns. Pyth on Sui also automatically pushes prices on-chain for a subset of symbols. More information on this TBA.
 
 Users of the Pyth contract will typically need to perform two operations:
 
 - Update the on-chain price -- In off-chain code, retrieve a verified price update from the
   [price service](documentation/pythnet-price-feeds/price-service) and submit it to the contract
   for verification. This operation makes the price available for on-chain use.
-  You will typically call [update_price_feeds](aptos/update-price-feeds) to do this.
+  You will typically call [update_price_feeds](sui/update-price-feeds) to do this.
 - Read the on-chain price -- After updating the price, your on-chain contract can call one of the
-  many getter functions on the contract to get the price. See [get_price](aptos/get-price) and its variants
+  many getter functions on the contract to get the price. See [get_price](sui/get-price) and its variants
   for more information.

pages/sui/price-feed-exists.mdx

@@ -10,7 +10,7 @@ import Examples from "../../components/Examples";
 
 Determine if a price feed for the given `price_identifier` exists.
 Returns `true` if there has been at least one on-chain update of this feed in the past.
-Note that a `false` answer may mean that the feed exists, but simply has never been updated on Aptos.
+Note that a `false` answer may mean that the feed exists, but simply has never been updated on Sui.
 In this case, you can invoke [update_price_feeds](update-price-feeds) to pull an update on-chain.
 
 <div className="mt-6 overflow-x-auto">

pages/sui/sdks.mdx

@@ -2,7 +2,7 @@ import { Tab, Tabs } from "nextra-theme-docs";
 
 # SDKs
 
-Aptos contracts can program against the Pyth contract's interface by including it as a project dependency.
+Sui contracts can program against the Pyth contract's interface by including it as a project dependency.
 
 ## Installation Instructions
 
@@ -12,24 +12,23 @@ Aptos contracts can program against the Pyth contract's interface by including i
 
         ```toml
         [dependencies]
-        Pyth = { git = "https://github.com/pyth-network/pyth-crosschain.git", subdir = "target_chains/aptos/contracts", rev = "main" }
+        Pyth = { git = "https://github.com/pyth-network/pyth-crosschain.git", subdir = "target_chains/sui/contracts", rev = "main" }
         ```
 
         Note that this dependency references the latest version of the Pyth contract code.
         You can also choose the most recent git sha in order to have a repeatable build.
-        This contract was compiled with [aptos-cli v1.0.4](https://github.com/aptos-labs/aptos-core/releases/tag/aptos-cli-v1.0.4).
+        This contract was compiled with sui-cli sui 1.0.0-09b208149.
 
         Next, add the following named addresses to the `[addresses]` section of `Move.toml`:
 
         ```toml
         [addresses]
-        pyth = "0x7e783b349d3e89cf5931af376ebeadbfab855b3fa239b7ada8f5a92fbea6b387"
-        deployer = "0xb31e712b26fd295357355f6845e77c888298636609e93bc9b05f0f604049f434"
-        wormhole = "0x5bc11445584a763c1fa7ed39081f1b920954da14e04b32440cba863d03e19625"
+        pyth = TBA
+        wormhole = TBA
         ```
 
         These lines allow you to reference Pyth resources as `pyth` instead of manually writing the contract address.
-        The contract addresses provided above are for both Aptos mainnet and testnet -- the Pyth contract has the same address in both cases.
+        The contract addresses provided above are for both Sui mainnet -- the Pyth contract has a different address on testnet (contract addresses on Sui are not generated deterministically).
 
         You can now import the Pyth interfaces in Move code as follows:
 

pages/sui/update-single-price-feed.mdx

@@ -25,11 +25,16 @@ Reverts if the required fee is not paid, or the `update_data` is incorrectly sig
 
 | Argument                                                         | Input                                                      | Description                                                                                           |
 | ---------------------------------------------------------------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
-| <Arg required={true} type="vector<vector<u8>>">update_data</Arg> | <Input id="update_data" format={InputFormats.ByteArray} /> | The price update data for the contract to verify.                                                     |
-| <Arg required={true} type="Coin<AptosCoin>">fee</Arg>            | <Input id="fee" format={InputFormats.BigInt}/>             | The update fee in octa. This fee is transferred to the Pyth contract as an effect of the transaction. |
-
+| <Arg required={true} type="&PythState">pyth_state</Arg>          | <Input id="pyth_state" format={InputFormats.ByteArray} /> | The Pyth state object.                                                     |
+| <Arg required={true} type=" HotPotatoVector<PriceInfo>,">price_updates</Arg>            | <Input id="price_updates" format={InputFormats.BigInt}/> | vector of authenticated price updates |
+| <Arg required={true} type=" &mut PriceInfoObject">price_info_object</Arg>            | <Input id="price_info_object" format={InputFormats.BigInt}/> | PriceInfoObject is a shared Sui object containing the price feed to be updated. |
+| <Arg required={true} type=" Coin<SUI>">fee</Arg>            | <Input id="fee" format={InputFormats.BigInt}/> | Fee coins. |
+| <Arg required={true} type=" &Clock">clock</Arg> | <Input id="clock" format={InputFormats.BigInt}/> | clock is a Sui shared object used to tell time and record timestamps |
 </div>
 
+# Warning: do not hardcode price feed updates in your contract
+`update_single_price_feed` is meant to be called in a chain of programmable transactions, rather than hardcoded in a contract. This is because when a Sui contract upgrades, the upgraded version lives at a different address. When this happens the previous callsite gets bricked, or becomes un-callable. It is up to the user to use the correct call-site (we also have a helper function for finding the latest call-site given the Pyth state object ID, which is unchanged between upgrades). 
+
 <Examples>
   <Example
     keyValues={{
@@ -43,36 +48,10 @@ Reverts if the required fee is not paid, or the `update_data` is incorrectly sig
           )
         ),
       fee: async (ctx) => {
-        // NOTE: this technically could get the update fee for a different VAA than the one above.
-        // This shouldn't affect the update fee as long as the fee is only dependent on the price feed ids
-        // and not the specific content of the price update.
         let vaa = (await ctx.getLatestPriceFeed("Crypto.BTC/USD")).vaa;
         return await ctx.getEthUpdateFee([vaa]);
       },
     }}
-    value="Latest BTC/USD update data"
+    Example TBA
   />
 </Examples>
-
-## Example Code
-
-<Tabs items={['Move']}>
-    <Tab>
-        <DynamicCode targets={{
-            "1": (ctx) => ctx.get("update_data", "<update_data>"),
-            "2": (ctx) => ctx.get("fee", "<fee>"),
-        }}>
-            ```rust copy
-            use pyth::pyth;
-            use pyth::price_identifier;
-
-            let coins = coin::withdraw<AptosCoin>(payer, 2)
-            pyth::update_price_feeds(
-              vec![1],
-              coins
-            );
-            ```
-        </DynamicCode>
-    </Tab>
-
-</Tabs>