[Sui 21/x] - pyth-sui-js SDK #1004

optke3 · 2023-08-04T20:41:06Z

Summary

Pyth Sui JS SDK
SuiPriceServiceConnection class
SuiRelay example for fetching update data and updating a price feed
helpers for updating price feed using accumulator message / batch price attestation, getting latest package ids given Wormhole or Pyth state, parsing VAA from accumulator msg, etc.
add updated examples to README

TODOs

publish the pyth-sui-js npm package so that it is available to users via npm install --save @pythnetwork/pyth-sui-js

vercel · 2023-08-04T20:41:13Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
example-oracle-amm	⬜️ Ignored (Inspect)	Visit Preview		Aug 15, 2023 8:41am
xc-admin-frontend	⬜️ Ignored (Inspect)	Visit Preview		Aug 15, 2023 8:41am

…into sui_js_sdk

- normalize sui js sdk batch price attestation and accumulator update functions to take in base64 string (as opposed to hex)

…into sui_js_sdk

…updatePriceFeedWithBatchPriceAttestation

ali-behjati

It's the most complex sdk that we have had so far! I left some inline comments.

Also on sui/scripts/pyth:

Can we remove Yarn in favor of our package?
It's good to make it a local package which relies local dependencies instead of their released version

ali-behjati · 2023-08-14T14:52:52Z

target_chains/sui/sdk/js/package-lock.json

This should not exists when we have lerna. We should instead add this package to the global package.json file

ali-behjati · 2023-08-14T14:57:36Z

target_chains/sui/sdk/js/src/examples/SuiRelay.ts

+import { SuiPriceServiceConnection } from "../index";
+
+const argv = yargs(hideBin(process.argv))
+  .option("price-feed", {


ideally it's better to accept multiple price feeds

ali-behjati · 2023-08-14T15:01:12Z

target_chains/sui/sdk/js/src/index.ts

@@ -0,0 +1,2 @@
+export { SuiPriceServiceConnection } from "./SuiPriceServiceConnection";
+export { SuiPythClient } from "./client";


Good to export other useful types as well like this

ali-behjati · 2023-08-14T15:04:53Z

target_chains/sui/sdk/js/src/SuiPriceServiceConnection.ts

+   * @param priceIds Array of hex-encoded price ids.
+   * @returns Array of price update data.
+   */
+  async getPriceFeedsUpdateData(priceIds: HexString[]): Promise<number[][]> {


number[] is a weird type. I prefer passing arrays of buffers instead and do the conversion on the edges as Buffer is more known as the data blob type.

ali-behjati · 2023-08-14T15:11:29Z

target_chains/sui/sdk/js/src/client.ts

+    const trailingPayloadSize = accumulatorMessage.slice(6, 7)[0];
+    const vaaSizeOffset =
+      7 + // header bytes (header(4) + major(1) + minor(1) + trailing payload size(1))
+      trailingPayloadSize + // trailing payload (variable number of bytes)
+      1; // proof_type (1 byte)
+    const vaaSizeBytes = accumulatorMessage.slice(
+      vaaSizeOffset,
+      vaaSizeOffset + 2
+    );
+    const vaaSize = vaaSizeBytes[1] + 16 * vaaSizeBytes[0];
+    const vaaOffset = vaaSizeOffset + 2;
+    return accumulatorMessage.slice(vaaOffset, vaaOffset + vaaSize);


If you use Buffer you can use buffer.readUint...

ali-behjati · 2023-08-14T15:13:33Z

target_chains/sui/sdk/js/src/client.ts

+      if (updates.length > 1) {
+        throw new Error(
+          "SDK does not support sending multiple accumulator messages in a single transaction"
+        );


Just for the sake of simplicity of the sdk and the fact that it's rare.

ali-behjati · 2023-08-14T15:15:39Z

target_chains/sui/sdk/js/src/client.ts

+        throw new Error(
+          `Price feed ${feedId} not found, please create it first`
+        );


Ideally we don't want to create this ourself each time. Isn't it better to add the object creation part to the tx if possible?

I will try but last time I checked it was not that easy.

PriceInfoObjects are shared objects and should be specified by user as inputs to the transaction. Therefore, it's not possible to create and use them in the same transaction.

ali-behjati · 2023-08-14T15:16:21Z

target_chains/sui/sdk/js/src/client.ts

+        );
+      }
+      priceInfoObjects.push(priceInfoObjectId);
+      const coin = tx.splitCoins(tx.gas, [tx.pure(1)]);


Is it assuming the update cost is always 1 per price feed? I think we should query it from on-chain.

ali-behjati

Thanks! I'm still a bit unclear on the createPrice part and the single sized update data but i don't have much context to judge.

Please add this package to the global package.json file before merging.
https://github.com/pyth-network/pyth-crosschain/blob/main/package.json

optke3 added 3 commits August 4, 2023 19:43

start sui js sdk

ee5eb60

comments

b8254ec

Merge branch 'main' into sui_js_sdk

b4f5b6f

edit readme

8e3e9fa

optke3 changed the title ~~[Sui 21/x] - js sdk~~ [Sui 21/x] - pyth-sui-js Aug 4, 2023

optke3 changed the title ~~[Sui 21/x] - pyth-sui-js~~ [Sui 21/x] - pyth-sui-js SDK Aug 4, 2023

optke3 and others added 23 commits August 4, 2023 22:24

precommit run all files

9fdaa2c

Update README.md

29949ce

add helper get_price_feed_ids_to_price_info_object_ids_table

951ca9a

Merge branch 'sui_js_sdk' of github.com:pyth-network/pyth-crosschain …

056a7c1

…into sui_js_sdk

edit

abb04d9

additions to SUI sdk Relay and helpers

8e66ac2

updats to SuiRelay, helpers, and SuiPriceServiceConnection

9bd3bbc

uncomment some code

8bf7635

get SuiRelay.ts example working

f99ca62

simplify SuiPriceServiceConnection

12050e1

Update README.md

0ba2fcb

Update README.md

da67170

Update README.md

c645abb

Update README.md

b724cdd

Update README.md

de4587c

Update README.md

67e78d1

Update README.md

8100052

Update README.md

2e31e79

Update SuiPriceServiceConnection.ts

3d6ed34

Update README.md

8922251

Update README.md

1803b8c

- add node to tsconfig compiler options types

6d8c61f

- normalize sui js sdk batch price attestation and accumulator update functions to take in base64 string (as opposed to hex)

Merge branch 'sui_js_sdk' of github.com:pyth-network/pyth-crosschain …

d1f5d9f

…into sui_js_sdk

optke3 added 2 commits August 9, 2023 17:49

updatePriceFeed that dispatches to updatePriceFeedWithAccumulator or …

72094b0

…updatePriceFeedWithBatchPriceAttestation

code comments

c8402a6

optke3 requested a review from m30m August 9, 2023 19:00

optke3 marked this pull request as ready for review August 9, 2023 19:00

optke3 requested review from jayantk and ali-behjati August 9, 2023 19:00

m30m added 4 commits August 11, 2023 09:46

Fix some linting issues

6369f1b

Make the sdk easier on devs

74bc5bb

Small improvements and more documentation

830be88

Small cleanup

fc718e0

ali-behjati reviewed Aug 14, 2023

View reviewed changes

Address PR comments

aeea8c6

ali-behjati approved these changes Aug 14, 2023

View reviewed changes

m30m added 3 commits August 15, 2023 09:56

Add sui js sdk to packages

cf82344

Small bugfixes

636bc9d

Update dependencies and package lock

ca9959d

m30m merged commit 55129e5 into main Aug 15, 2023

m30m deleted the sui_js_sdk branch August 15, 2023 08:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[Sui 21/x] - pyth-sui-js SDK #1004

[Sui 21/x] - pyth-sui-js SDK #1004

Uh oh!

optke3 commented Aug 4, 2023 •

edited

Loading

Uh oh!

vercel bot commented Aug 4, 2023 •

edited

Loading

Uh oh!

ali-behjati left a comment

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

m30m Aug 14, 2023

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

m30m Aug 14, 2023

Uh oh!

m30m Aug 15, 2023

Uh oh!

ali-behjati Aug 14, 2023

Uh oh!

ali-behjati left a comment •

edited

Loading

Uh oh!

Uh oh!

		@@ -0,0 +1,2 @@
		export { SuiPriceServiceConnection } from "./SuiPriceServiceConnection";
		export { SuiPythClient } from "./client";

[Sui 21/x] - pyth-sui-js SDK #1004

[Sui 21/x] - pyth-sui-js SDK #1004

Uh oh!

Conversation

optke3 commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

TODOs

Uh oh!

vercel bot commented Aug 4, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ali-behjati left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ali-behjati left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

optke3 commented Aug 4, 2023 •

edited

Loading

vercel bot commented Aug 4, 2023 •

edited

Loading

ali-behjati left a comment •

edited

Loading