Merge branch 'pyth-network:main' into main

Author: aUsABuisnessman

README.md

@@ -1,10 +1,12 @@
 # @pythnetwork/client
 
-## A library for reading on-chain Pyth oracle data
+## A library for reading Pyth accounts on Pythnet
 
 [Pyth](https://pyth.network/) is building a way to deliver a decentralized, cross-chain market of verifiable data from high-quality nodes to any smart contract, anywhere.
 
-This library reads on-chain Pyth data from [@solana/web3.js](https://www.npmjs.com/package/@solana/web3.js) and returns JavaScript-friendly objects.
+This library reads Pythnet (Pyth's app-specific SVM blockchain) data using [@solana/web3.js](https://www.npmjs.com/package/@solana/web3.js) and returns JavaScript-friendly objects.
+
+> ⚠️ **Important Warning**: For most use cases, it is recommended and more user-friendly to use Pyth's off-chain API ([Hermes](https://hermes.pyth.network/docs/)) via the [@pythnetwork/hermes-client](https://www.npmjs.com/package/@pythnetwork/hermes-client) package to get the most up-to-date Pyth prices. Using `@pythnetwork/client` requires a Pythnet RPC connection and exposes many low-level details.
 
 ## Installation
 
@@ -29,7 +31,7 @@ This library lets you consume prices in two different ways: you can either get c
 The websocket connection provides a subscription model for consuming price updates:
 
 ```typescript
-const pythConnection = new PythConnection(solanaWeb3Connection, getPythProgramKeyForCluster(solanaClusterName))
+const pythConnection = new PythConnection(pythnetWeb3Connection, getPythProgramKeyForCluster(pythnetClusterName))
 pythConnection.onPriceChange((product, price) => {
   // sample output:
   // Crypto.SRM/USD: $8.68725 ±$0.0131 Status: Trading

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@pythnetwork/client",
-  "version": "2.22.0",
+  "version": "2.22.1",
   "description": "Client for consuming Pyth price data",
   "homepage": "https://pyth.network",
   "main": "lib/index.js",

package.json

@@ -58,6 +58,21 @@ test('Anchor', (done) => {
       expect(decoded?.data.generic_symbol).toBe('ETHUSD')
     })
 
+  pythOracle.methods
+    .addProduct({
+      '😆': 'ÉTH',
+    })
+    .accounts({
+      fundingAccount: PublicKey.unique(),
+      productAccount: PublicKey.unique(),
+      tailMappingAccount: PublicKey.unique(),
+    })
+    .instruction()
+    .then((instruction) => {
+      const decoded = pythOracleCoder().instruction.decode(instruction.data)
+      expect(decoded?.data['😆']).toBe('ÉTH')
+    })
+
   pythOracle.methods
     .updProduct({
       asset_type: 'Crypto',

src/__tests__/Anchor.test.ts

@@ -104,8 +104,8 @@ test('Handle price getting stale', (done) => {
   expect(price.magic).toBe(Magic)
   expect(price.version).toBe(Version)
   expect(price.status).toBe(PriceStatus.Trading)
-  expect(price.flags.accumulatorV2).toBe(false);
-  expect(price.flags.messageBufferCleared).toBe(false);
+  expect(price.flags.accumulatorV2).toBe(false)
+  expect(price.flags.messageBufferCleared).toBe(false)
   expect(price.feedIndex).toBe(0)
 
   expect(parsePriceData(data, price.aggregate.publishSlot + MAX_SLOT_DIFFERENCE).status).toBe(PriceStatus.Trading)
@@ -143,8 +143,8 @@ test('Handle flags', (done) => {
   const data = Buffer.from(b64_data, 'base64')
   const price = parsePriceData(data)
 
-  expect(price.flags.accumulatorV2).toBe(true);
-  expect(price.flags.messageBufferCleared).toBe(true);
+  expect(price.flags.accumulatorV2).toBe(true)
+  expect(price.flags.messageBufferCleared).toBe(true)
 
   done()
 })

src/__tests__/Price.test.ts

@@ -93,9 +93,9 @@ export class PythOracleInstructionCoder implements InstructionCoder {
     if (methodName === 'updProduct' || methodName === 'addProduct') {
       let offset = 0
       for (const key of Object.keys(ix.productMetadata)) {
-        offset += buffer.subarray(offset).writeUInt8(key.length)
+        offset += buffer.subarray(offset).writeUInt8(Buffer.byteLength(key))
         offset += buffer.subarray(offset).write(key)
-        offset += buffer.subarray(offset).writeUInt8(ix.productMetadata[key].length)
+        offset += buffer.subarray(offset).writeUInt8(Buffer.byteLength(ix.productMetadata[key]))
         offset += buffer.subarray(offset).write(ix.productMetadata[key])
       }
       if (offset > MAX_METADATA_SIZE) {

src/anchor/coder/instructions.ts

@@ -42,8 +42,8 @@ export enum AccountType {
 }
 
 export type Flags = {
-  accumulatorV2: boolean,
-  messageBufferCleared: boolean,
+  accumulatorV2: boolean
+  messageBufferCleared: boolean
 }
 
 const empty32Buffer = Buffer.alloc(32)
@@ -110,7 +110,7 @@ export interface PriceData extends Base {
   minPublishers: number
   messageSent: number
   maxLatency: number
-  flags: Flags,
+  flags: Flags
   feedIndex: number
   productAccountKey: PublicKey
   nextPriceAccountKey: PublicKey | null
@@ -300,8 +300,8 @@ export const parsePriceData = (data: Buffer, currentSlot?: number): PriceData =>
 
   /* tslint:disable:no-bitwise */
   const flags = {
-    accumulatorV2: (flagBits & (1<<0)) !== 0,
-    messageBufferCleared: (flagBits & (1<<1)) !== 0,
+    accumulatorV2: (flagBits & (1 << 0)) !== 0,
+    messageBufferCleared: (flagBits & (1 << 1)) !== 0,
   }
   /* tslint:enable:no-bitwise */