@pythnetwork/price-pusher 4.1.2 → 5.4.2

package/lib/sui/sui.js

@@ -0,0 +1,358 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SuiPricePusher = exports.SuiPriceListener = void 0;
+const interface_1 = require("../interface");
+const sui_js_1 = require("@mysten/sui.js");
+const GAS_FEE_FOR_SPLIT = 2_000_000_000;
+// TODO: read this from on chain config
+const MAX_NUM_GAS_OBJECTS_IN_PTB = 256;
+const MAX_NUM_OBJECTS_IN_ARGUMENT = 510;
+class SuiPriceListener extends interface_1.ChainPriceListener {
+    pythPackageId;
+    priceFeedToPriceInfoObjectTableId;
+    endpoint;
+    constructor(pythPackageId, priceFeedToPriceInfoObjectTableId, endpoint, priceItems, config) {
+        super("sui", config.pollingFrequency, priceItems);
+        this.pythPackageId = pythPackageId;
+        this.priceFeedToPriceInfoObjectTableId = priceFeedToPriceInfoObjectTableId;
+        this.endpoint = endpoint;
+    }
+    async getOnChainPriceInfo(priceId) {
+        try {
+            const provider = new sui_js_1.JsonRpcProvider(new sui_js_1.Connection({ fullnode: this.endpoint }));
+            const priceInfoObjectId = await priceIdToPriceInfoObjectId(provider, this.pythPackageId, this.priceFeedToPriceInfoObjectTableId, priceId);
+            // Fetching the price info object for the above priceInfoObjectId
+            const priceInfoObject = await provider.getObject({
+                id: priceInfoObjectId,
+                options: { showContent: true },
+            });
+            if (priceInfoObject.data === undefined ||
+                priceInfoObject.data.content === undefined)
+                throw new Error("Price not found on chain for price id " + priceId);
+            if (priceInfoObject.data.content.dataType !== "moveObject")
+                throw new Error("fetched object datatype should be moveObject");
+            const { magnitude, negative } = priceInfoObject.data.content.fields.price_info.fields.price_feed.fields
+                .price.fields.price.fields;
+            const conf = priceInfoObject.data.content.fields.price_info.fields.price_feed.fields
+                .price.fields.conf;
+            const timestamp = priceInfoObject.data.content.fields.price_info.fields.price_feed.fields
+                .price.fields.timestamp;
+            return {
+                price: negative ? "-" + magnitude : magnitude,
+                conf,
+                publishTime: Number(timestamp),
+            };
+        }
+        catch (e) {
+            console.error(`Polling Sui on-chain price for ${priceId} failed. Error:`);
+            console.error(e);
+            return undefined;
+        }
+    }
+}
+exports.SuiPriceListener = SuiPriceListener;
+class SuiPricePusher {
+    signer;
+    priceServiceConnection;
+    pythPackageId;
+    pythStateId;
+    wormholePackageId;
+    wormholeStateId;
+    priceFeedToPriceInfoObjectTableId;
+    maxVaasPerPtb;
+    gasBudget;
+    gasPool;
+    constructor(signer, priceServiceConnection, pythPackageId, pythStateId, wormholePackageId, wormholeStateId, priceFeedToPriceInfoObjectTableId, maxVaasPerPtb, endpoint, mnemonic, gasBudget, gasPool) {
+        this.signer = signer;
+        this.priceServiceConnection = priceServiceConnection;
+        this.pythPackageId = pythPackageId;
+        this.pythStateId = pythStateId;
+        this.wormholePackageId = wormholePackageId;
+        this.wormholeStateId = wormholeStateId;
+        this.priceFeedToPriceInfoObjectTableId = priceFeedToPriceInfoObjectTableId;
+        this.maxVaasPerPtb = maxVaasPerPtb;
+        this.gasBudget = gasBudget;
+        this.gasPool = gasPool;
+    }
+    /**
+     * Create a price pusher with a pool of `numGasObjects` gas coins that will be used to send transactions.
+     * The gas coins of the wallet for the provided mnemonic will be merged and then evenly split into `numGasObjects`.
+     */
+    static async createWithAutomaticGasPool(priceServiceConnection, pythPackageId, pythStateId, wormholePackageId, wormholeStateId, priceFeedToPriceInfoObjectTableId, maxVaasPerPtb, endpoint, mnemonic, gasBudget, numGasObjects) {
+        if (numGasObjects > MAX_NUM_OBJECTS_IN_ARGUMENT) {
+            throw new Error(`numGasObjects cannot be greater than ${MAX_NUM_OBJECTS_IN_ARGUMENT} until we implement split chunking`);
+        }
+        const signer = new sui_js_1.RawSigner(sui_js_1.Ed25519Keypair.deriveKeypair(mnemonic), new sui_js_1.JsonRpcProvider(new sui_js_1.Connection({ fullnode: endpoint })));
+        const gasPool = await SuiPricePusher.initializeGasPool(signer, numGasObjects);
+        return new SuiPricePusher(signer, priceServiceConnection, pythPackageId, pythStateId, wormholePackageId, wormholeStateId, priceFeedToPriceInfoObjectTableId, maxVaasPerPtb, endpoint, mnemonic, gasBudget, gasPool);
+    }
+    async updatePriceFeed(priceIds, pubTimesToPush) {
+        if (priceIds.length === 0) {
+            return;
+        }
+        if (priceIds.length !== pubTimesToPush.length)
+            throw new Error("Invalid arguments");
+        if (this.gasPool.length === 0) {
+            console.warn("Skipping update: no available gas coin.");
+            return;
+        }
+        const priceFeeds = await this.priceServiceConnection.getLatestPriceFeeds(priceIds);
+        if (priceFeeds === undefined) {
+            console.warn("Failed to fetch price updates. Skipping push.");
+            return;
+        }
+        const vaaToPriceFeedIds = new Map();
+        for (const priceFeed of priceFeeds) {
+            // The ! will succeed as long as the priceServiceConnection is configured to return binary vaa data (which it is).
+            const vaa = priceFeed.getVAA();
+            if (!vaaToPriceFeedIds.has(vaa)) {
+                vaaToPriceFeedIds.set(vaa, []);
+            }
+            vaaToPriceFeedIds.get(vaa).push(priceFeed.id);
+        }
+        const txs = [];
+        let currentBatchVaas = [];
+        let currentBatchPriceFeedIds = [];
+        for (const [vaa, priceFeedIds] of vaaToPriceFeedIds.entries()) {
+            currentBatchVaas.push(vaa);
+            currentBatchPriceFeedIds.push(...priceFeedIds);
+            if (currentBatchVaas.length >= this.maxVaasPerPtb) {
+                const tx = await this.createPriceUpdateTransaction(currentBatchVaas, currentBatchPriceFeedIds);
+                if (tx !== undefined) {
+                    txs.push(tx);
+                }
+                currentBatchVaas = [];
+                currentBatchPriceFeedIds = [];
+            }
+        }
+        await this.sendTransactionBlocks(txs);
+    }
+    async createPriceUpdateTransaction(vaas, priceIds) {
+        const tx = new sui_js_1.TransactionBlock();
+        // Parse our batch price attestation VAA bytes using Wormhole.
+        // Check out the Wormhole cross-chain bridge and generic messaging protocol here:
+        //     https://github.com/wormhole-foundation/wormhole
+        let verified_vaas = [];
+        for (const vaa of vaas) {
+            const [verified_vaa] = tx.moveCall({
+                target: `${this.wormholePackageId}::vaa::parse_and_verify`,
+                arguments: [
+                    tx.object(this.wormholeStateId),
+                    tx.pure([...Buffer.from(vaa, "base64")]),
+                    tx.object(sui_js_1.SUI_CLOCK_OBJECT_ID),
+                ],
+            });
+            verified_vaas = verified_vaas.concat(verified_vaa);
+        }
+        // Create a hot potato vector of price feed updates that will
+        // be used to update price feeds.
+        let [price_updates_hot_potato] = tx.moveCall({
+            target: `${this.pythPackageId}::pyth::create_price_infos_hot_potato`,
+            arguments: [
+                tx.object(this.pythStateId),
+                tx.makeMoveVec({
+                    type: `${this.wormholePackageId}::vaa::VAA`,
+                    objects: verified_vaas,
+                }),
+                tx.object(sui_js_1.SUI_CLOCK_OBJECT_ID),
+            ],
+        });
+        // Update each price info object (containing our price feeds of interest)
+        // using the hot potato vector.
+        for (const priceId of priceIds) {
+            let priceInfoObjectId;
+            try {
+                priceInfoObjectId = await priceIdToPriceInfoObjectId(this.signer.provider, this.pythPackageId, this.priceFeedToPriceInfoObjectTableId, priceId);
+            }
+            catch (e) {
+                console.log("Error fetching price info object id for ", priceId);
+                console.error(e);
+                return undefined;
+            }
+            const coin = tx.splitCoins(tx.gas, [tx.pure(1)]);
+            [price_updates_hot_potato] = tx.moveCall({
+                target: `${this.pythPackageId}::pyth::update_single_price_feed`,
+                arguments: [
+                    tx.object(this.pythStateId),
+                    price_updates_hot_potato,
+                    tx.object(priceInfoObjectId),
+                    coin,
+                    tx.object(sui_js_1.SUI_CLOCK_OBJECT_ID),
+                ],
+            });
+        }
+        // Explicitly destroy the hot potato vector, since it can't be dropped
+        // automatically.
+        tx.moveCall({
+            target: `${this.pythPackageId}::hot_potato_vector::destroy`,
+            arguments: [price_updates_hot_potato],
+            typeArguments: [`${this.pythPackageId}::price_info::PriceInfo`],
+        });
+        return tx;
+    }
+    /** Send every transaction in txs in parallel, returning when all transactions have completed. */
+    async sendTransactionBlocks(txs) {
+        return Promise.all(txs.map((tx) => this.sendTransactionBlock(tx)));
+    }
+    /** Send a single transaction block using a gas coin from the pool. */
+    async sendTransactionBlock(tx) {
+        const gasObject = this.gasPool.shift();
+        if (gasObject === undefined) {
+            console.warn("No available gas coin. Skipping push.");
+            return;
+        }
+        let nextGasObject = undefined;
+        try {
+            tx.setGasPayment([gasObject]);
+            tx.setGasBudget(this.gasBudget);
+            const result = await this.signer.signAndExecuteTransactionBlock({
+                transactionBlock: tx,
+                options: {
+                    showEffects: true,
+                },
+            });
+            nextGasObject = (0, sui_js_1.getTransactionEffects)(result)
+                ?.mutated?.map((obj) => obj.reference)
+                .find((ref) => ref.objectId === gasObject.objectId);
+            console.log("Successfully updated price with transaction digest ", result.digest);
+        }
+        catch (e) {
+            console.log("Error when signAndExecuteTransactionBlock");
+            if (String(e).includes("GasBalanceTooLow")) {
+                console.warn(`The balance of gas object ${gasObject.objectId} is too low. Removing from pool.`);
+            }
+            else {
+                nextGasObject = gasObject;
+            }
+            console.error(e);
+        }
+        if (nextGasObject !== undefined) {
+            this.gasPool.push(nextGasObject);
+        }
+    }
+    // This function will smash all coins owned by the signer into one, and then
+    // split them equally into numGasObjects.
+    static async initializeGasPool(signer, numGasObjects) {
+        const signerAddress = await signer.getAddress();
+        const { totalBalance: balance } = await signer.provider.getBalance({
+            owner: signerAddress,
+        });
+        const splitAmount = (BigInt(balance) - BigInt(GAS_FEE_FOR_SPLIT)) / BigInt(numGasObjects);
+        const consolidatedCoin = await SuiPricePusher.mergeGasCoinsIntoOne(signer, signerAddress);
+        const gasPool = await SuiPricePusher.splitGasCoinEqually(signer, signerAddress, Number(splitAmount), numGasObjects, consolidatedCoin);
+        console.log("Gas pool is filled with coins: ", gasPool);
+        return gasPool;
+    }
+    static async getAllGasCoins(provider, owner) {
+        let hasNextPage = true;
+        let cursor;
+        const coins = new Set([]);
+        let numCoins = 0;
+        while (hasNextPage) {
+            const paginatedCoins = await provider.getCoins({
+                owner,
+                cursor,
+            });
+            numCoins += paginatedCoins.data.length;
+            paginatedCoins.data.forEach((c) => coins.add(JSON.stringify({
+                objectId: c.coinObjectId,
+                version: c.version,
+                digest: c.digest,
+            })));
+            hasNextPage = paginatedCoins.hasNextPage;
+            cursor = paginatedCoins.nextCursor;
+        }
+        if (numCoins !== coins.size) {
+            throw new Error("Unexpected getCoins result: duplicate coins found");
+        }
+        return [...coins].map((item) => JSON.parse(item));
+    }
+    static async splitGasCoinEqually(signer, signerAddress, splitAmount, numGasObjects, gasCoin) {
+        // TODO: implement chunking if numGasObjects exceeds MAX_NUM_CREATED_OBJECTS
+        const tx = new sui_js_1.TransactionBlock();
+        const coins = tx.splitCoins(tx.gas, Array.from({ length: numGasObjects }, () => tx.pure(splitAmount)));
+        tx.transferObjects(Array.from({ length: numGasObjects }, (_, i) => coins[i]), tx.pure(signerAddress));
+        tx.setGasPayment([gasCoin]);
+        const result = await signer.signAndExecuteTransactionBlock({
+            transactionBlock: tx,
+            options: { showEffects: true },
+        });
+        const error = (0, sui_js_1.getExecutionStatusError)(result);
+        if (error) {
+            throw new Error(`Failed to initialize gas pool: ${error}. Try re-running the script`);
+        }
+        const newCoins = (0, sui_js_1.getCreatedObjects)(result).map((obj) => obj.reference);
+        if (newCoins.length !== numGasObjects) {
+            throw new Error(`Failed to initialize gas pool. Expected ${numGasObjects}, got: ${newCoins}`);
+        }
+        return newCoins;
+    }
+    static async mergeGasCoinsIntoOne(signer, owner) {
+        const gasCoins = await SuiPricePusher.getAllGasCoins(signer.provider, owner);
+        // skip merging if there is only one coin
+        if (gasCoins.length === 1) {
+            return gasCoins[0];
+        }
+        const gasCoinsChunks = chunkArray(gasCoins, MAX_NUM_GAS_OBJECTS_IN_PTB - 2);
+        let finalCoin;
+        for (let i = 0; i < gasCoinsChunks.length; i++) {
+            const mergeTx = new sui_js_1.TransactionBlock();
+            let coins = gasCoinsChunks[i];
+            if (finalCoin) {
+                coins = [finalCoin, ...coins];
+            }
+            mergeTx.setGasPayment(coins);
+            const mergeResult = await signer.signAndExecuteTransactionBlock({
+                transactionBlock: mergeTx,
+                options: { showEffects: true },
+            });
+            const error = (0, sui_js_1.getExecutionStatusError)(mergeResult);
+            if (error) {
+                throw new Error(`Failed to merge coins when initializing gas pool: ${error}. Try re-running the script`);
+            }
+            finalCoin = (0, sui_js_1.getTransactionEffects)(mergeResult).mutated.map((obj) => obj.reference)[0];
+        }
+        return finalCoin;
+    }
+}
+exports.SuiPricePusher = SuiPricePusher;
+// We are calculating stored price info object id for given price id
+// The mapping between which is static. Hence, we are caching it here.
+const CACHE = {};
+// For given priceid, this method will fetch the price info object id
+// where the price information for the corresponding price feed is stored
+async function priceIdToPriceInfoObjectId(provider, pythPackageId, priceFeedToPriceInfoObjectTableId, priceId) {
+    // Check if this was fetched before.
+    if (CACHE[priceId] !== undefined)
+        return CACHE[priceId];
+    const storedObjectID = await provider.getDynamicFieldObject({
+        parentId: priceFeedToPriceInfoObjectTableId,
+        name: {
+            type: `${pythPackageId}::price_identifier::PriceIdentifier`,
+            value: {
+                bytes: "0x" + priceId,
+            },
+        },
+    });
+    if (storedObjectID.error !== undefined)
+        throw storedObjectID.error;
+    if (storedObjectID.data === undefined ||
+        storedObjectID.data.content === undefined)
+        throw new Error("Price not found on chain for price id " + priceId);
+    if (storedObjectID.data.content.dataType !== "moveObject")
+        throw new Error("fetched object datatype should be moveObject");
+    // This ID points to the price info object for the given price id stored on chain
+    const priceInfoObjectId = storedObjectID.data.content.fields.value;
+    // cache the price info object id
+    CACHE[priceId] = priceInfoObjectId;
+    return priceInfoObjectId;
+}
+function chunkArray(array, size) {
+    const chunked = [];
+    let index = 0;
+    while (index < array.length) {
+        chunked.push(array.slice(index, size + index));
+        index += size;
+    }
+    return chunked;
+}

package/lib/utils.d.ts

@@ -10,3 +10,4 @@ export declare function removeLeading0x(id: HexString): HexString;
 export declare function addLeading0x(id: HexString): HexString;
 export declare function isWsEndpoint(endpoint: string): boolean;
 export declare function verifyValidOption<options extends Readonly<Array<any>>, validOption extends options[number]>(option: any, validOptions: options): validOption;
+//# sourceMappingURL=utils.d.ts.map

package/lib/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAE9D,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAC/B,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACvC,eAAO,MAAM,QAAQ,uCAAwC,CAAC;AAC9D,MAAM,MAAM,OAAO,GAAG,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;AAC9C,eAAO,MAAM,iBAAiB,gBAAiB,CAAC;AAChD,MAAM,MAAM,gBAAgB,GAAG,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;AAEhE,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAErD;AAED,wBAAgB,eAAe,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,CAKxD;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,SAAS,GAAG,SAAS,CAKrD;AAED,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAStD;AAED,wBAAgB,iBAAiB,CAC/B,OAAO,SAAS,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EACpC,WAAW,SAAS,OAAO,CAAC,MAAM,CAAC,EACnC,MAAM,EAAE,GAAG,EAAE,YAAY,EAAE,OAAO,eAOnC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/price-pusher",
-  "version": "4.1.2",
+  "version": "5.4.2",
   "description": "Pyth Price Pusher",
   "homepage": "https://pyth.network",
   "main": "lib/index.js",
@@ -51,15 +51,17 @@
     "typescript": "^4.6.3"
   },
   "dependencies": {
-    "@injectivelabs/sdk-ts": "^1.0.484",
+    "@injectivelabs/sdk-ts": "1.10.72",
+    "@mysten/sui.js": "^0.34.0",
     "@pythnetwork/price-service-client": "*",
     "@pythnetwork/pyth-sdk-solidity": "*",
     "@truffle/hdwallet-provider": "^2.1.3",
+    "aptos": "^1.8.5",
     "joi": "^17.6.0",
     "web3": "^1.8.1",
     "web3-eth-contract": "^1.8.1",
     "yaml": "^2.1.1",
     "yargs": "^17.5.1"
   },
-  "gitHead": "61a66eecaa8c6480509e32df56d826ee484eefae"
+  "gitHead": "5e44fa4c95ae7120ee8a05f145b27470d2c48e7b"
 }