@reflectmoney/oracle.ts 1.0.1 → 2.1.0

package/README.md

@@ -25,7 +25,7 @@ yarn add @reflectmoney/oracle.ts
 ### Initialize Doppler
 
 ```typescript
-import { Doppler, PriceFeedSerializer } from "@reflectmoney/oracle.ts";
+import { Doppler, U8Array8Serializer, createPricePayload } from "@reflectmoney/oracle.ts";
 import { Connection, Keypair } from "@solana/web3.js";
 
 const connection = new Connection("https://api.mainnet-beta.solana.com");
@@ -41,26 +41,39 @@ import { PublicKey } from "@solana/web3.js";
 
 const oraclePublicKey = new PublicKey("ORACLE_ADDRESS");
 
+// Create a price payload (8 bytes representing a u64 value)
+const pricePayload = createPricePayload(BigInt(1_000_000)); // 1 USDC
+
 await doppler.updateOracle(
     oraclePublicKey,
     { 
-        payload: { price: BigInt(Math.pow(10, 6)) },
-        sequence: BigInt(Date.now())
+        slot: BigInt(Date.now()),
+        payload: pricePayload,
     },
-    new PriceFeedSerializer(),
+    new U8Array8Serializer(),
 );
 ```
 
 ### Fetch Oracle Data
 
 ```typescript
+import { readPriceFromPayload } from "@reflectmoney/oracle.ts";
+
 const oracleData = await doppler.fetchOracle(
     oraclePublicKey,
-    new PriceFeedSerializer(),
+    new U8Array8Serializer(),
 );
 
-console.log(oracleData);
-// { sequence: 1, payload: { price: 1000000n } }
+if (oracleData) {
+    console.log("Slot:", oracleData.slot);
+    
+    // Extract price from the 8-byte payload
+    const price = readPriceFromPayload(oracleData.payload);
+    console.log("Price:", price);
+}
+// Output:
+// Slot: 1728662400000n
+// Price: 1000000n
 ```
 
 ### Create an Oracle Account
@@ -68,10 +81,10 @@ console.log(oracleData);
 ```typescript
 const oracleAccount = await doppler.createOracleAccount(
     "my-oracle-seed",
-    new PriceFeedSerializer(), 
+    new U8Array8Serializer(), 
     { 
-        payload: { price: BigInt(Math.pow(10, 6)) },
-        sequence: 0n
+        slot: 0n,
+        payload: createPricePayload(BigInt(1_000_000)),
     }
 );
 ```

package/dist/index.d.ts

@@ -3,10 +3,10 @@ import { Buffer } from 'buffer';
 export declare const DOPPLER_PROGRAM_ID: PublicKey;
 export declare const ADMIN_PUBKEY: PublicKey;
 /**
- * Generic Oracle data structure
+ * Generic Oracle data structure matching Rust implementation
  */
 export interface Oracle<T> {
-    sequence: bigint;
+    slot: bigint;
     payload: T;
 }
 /**
@@ -18,27 +18,22 @@ export interface PayloadSerializer<T> {
     size(): number;
 }
 /**
- * Built-in serializer for u64 payloads (price feeds)
+ * Built-in serializer for [u8; 8] payloads (used for price feeds)
+ * The payload is simply 8 bytes representing data in little-endian format
  */
-export declare class U64Serializer implements PayloadSerializer<bigint> {
-    serialize(payload: bigint): Buffer;
-    deserialize(buffer: Buffer): bigint;
+export declare class U8Array8Serializer implements PayloadSerializer<Buffer> {
+    serialize(payload: Buffer): Buffer;
+    deserialize(buffer: Buffer): Buffer;
     size(): number;
 }
 /**
- * Price Feed structure matching the Rust implementation
+ * Helper function to create a [u8; 8] payload from a bigint price value
  */
-export interface PriceFeed {
-    price: bigint;
-}
+export declare function createPricePayload(price: bigint): Buffer;
 /**
- * Serializer for PriceFeed payloads
+ * Helper function to read a price value from a [u8; 8] payload
  */
-export declare class PriceFeedSerializer implements PayloadSerializer<PriceFeed> {
-    serialize(payload: PriceFeed): Buffer;
-    deserialize(buffer: Buffer): PriceFeed;
-    size(): number;
-}
+export declare function readPriceFromPayload(payload: Buffer): bigint;
 /**
  * Transaction builder for Doppler oracle updates
  */
@@ -52,7 +47,7 @@ export declare class TransactionBuilder {
     /**
      * Add an oracle update instruction to the transaction
      */
-    addOracleUpdate<T>(oraclePubkey: PublicKey, oracle: Oracle<T>, serializer: PayloadSerializer<T>): this;
+    addOracleUpdate<T>(oraclePubkey: PublicKey, payload: T, serializer: PayloadSerializer<T>): this;
     /**
      * Set the compute unit price in micro-lamports
      */
@@ -62,7 +57,6 @@ export declare class TransactionBuilder {
      */
     build(recentBlockhash: string): Transaction;
     private createUpdateInstruction;
-    private serializeOracle;
 }
 /**
  * Main Doppler class for interacting with oracle accounts
@@ -86,17 +80,17 @@ export declare class Doppler {
     /**
      * Create an oracle account with a seed
      */
-    createOracleAccount<T>(seed: string, serializer: PayloadSerializer<T>, initialOracle: Oracle<T>): Promise<PublicKey>;
+    createOracleAccount<T>(seed: string, serializer: PayloadSerializer<T>): Promise<PublicKey>;
     /**
      * Update a single oracle account
      */
-    updateOracle<T>(oraclePubkey: PublicKey, oracle: Oracle<T>, serializer: PayloadSerializer<T>, unitPrice?: bigint): Promise<string>;
+    updateOracle<T>(oraclePubkey: PublicKey, payload: T, serializer: PayloadSerializer<T>, unitPrice?: bigint): Promise<string>;
     /**
      * Update multiple oracle accounts in a single transaction
      */
     updateMultipleOracles<T>(updates: Array<{
         oraclePubkey: PublicKey;
-        oracle: Oracle<T>;
+        payload: T;
         serializer: PayloadSerializer<T>;
     }>, unitPrice?: bigint): Promise<string>;
     /**

package/dist/index.js

@@ -9,7 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Doppler = exports.TransactionBuilder = exports.PriceFeedSerializer = exports.U64Serializer = exports.ADMIN_PUBKEY = exports.DOPPLER_PROGRAM_ID = void 0;
+exports.Doppler = exports.TransactionBuilder = exports.U8Array8Serializer = exports.ADMIN_PUBKEY = exports.DOPPLER_PROGRAM_ID = void 0;
+exports.createPricePayload = createPricePayload;
+exports.readPriceFromPayload = readPriceFromPayload;
 const web3_js_1 = require("@solana/web3.js");
 const buffer_1 = require("buffer");
 const compute_budget_1 = require("@solana-program/compute-budget");
@@ -28,41 +30,44 @@ const COMPUTE_BUDGET_DATA_LIMIT_SIZE = 5;
 const COMPUTE_BUDGET_PROGRAM_SIZE = 22;
 const ORACLE_PROGRAM_SIZE = 36;
 /**
- * Built-in serializer for u64 payloads (price feeds)
+ * Built-in serializer for [u8; 8] payloads (used for price feeds)
+ * The payload is simply 8 bytes representing data in little-endian format
  */
-class U64Serializer {
+class U8Array8Serializer {
     serialize(payload) {
-        const buf = buffer_1.Buffer.alloc(8);
-        buf.writeBigUInt64LE(payload);
-        return buf;
+        if (payload.length !== 8) {
+            throw new Error('Payload must be exactly 8 bytes');
+        }
+        return payload;
     }
     deserialize(buffer) {
-        return buffer.readBigUInt64LE(0);
+        if (buffer.length < 8) {
+            throw new Error('Buffer must be at least 8 bytes');
+        }
+        return buffer.subarray(0, 8);
     }
     size() {
         return 8;
     }
 }
-exports.U64Serializer = U64Serializer;
+exports.U8Array8Serializer = U8Array8Serializer;
 /**
- * Serializer for PriceFeed payloads
+ * Helper function to create a [u8; 8] payload from a bigint price value
  */
-class PriceFeedSerializer {
-    serialize(payload) {
-        const buf = buffer_1.Buffer.alloc(8);
-        buf.writeBigUInt64LE(payload.price);
-        return buf;
-    }
-    deserialize(buffer) {
-        return {
-            price: buffer.readBigUInt64LE(0),
-        };
-    }
-    size() {
-        return 8;
+function createPricePayload(price) {
+    const buf = buffer_1.Buffer.alloc(8);
+    buf.writeBigUInt64LE(price);
+    return buf;
+}
+/**
+ * Helper function to read a price value from a [u8; 8] payload
+ */
+function readPriceFromPayload(payload) {
+    if (payload.length < 8) {
+        throw new Error('Payload must be at least 8 bytes');
     }
+    return payload.readBigUInt64LE(0);
 }
-exports.PriceFeedSerializer = PriceFeedSerializer;
 /**
  * Transaction builder for Doppler oracle updates
  */
@@ -80,10 +85,10 @@ class TransactionBuilder {
     /**
      * Add an oracle update instruction to the transaction
      */
-    addOracleUpdate(oraclePubkey, oracle, serializer) {
-        const instruction = this.createUpdateInstruction(oraclePubkey, oracle, serializer);
+    addOracleUpdate(oraclePubkey, payload, serializer) {
+        const instruction = this.createUpdateInstruction(oraclePubkey, payload, serializer);
         const payloadSize = serializer.size();
-        const oracleSize = 8 + payloadSize; // sequence + payload
+        const oracleSize = 8 + payloadSize; // slot + payload
         this.computeUnits +=
             SEQUENCE_CHECK_CU +
                 ADMIN_VERIFICATION_CU +
@@ -134,8 +139,8 @@ class TransactionBuilder {
         transaction.sign(this.admin);
         return transaction;
     }
-    createUpdateInstruction(oraclePubkey, oracle, serializer) {
-        const data = this.serializeOracle(oracle, serializer);
+    createUpdateInstruction(oraclePubkey, payload, serializer) {
+        const data = serializer.serialize(payload);
         return new web3_js_1.TransactionInstruction({
             programId: exports.DOPPLER_PROGRAM_ID,
             keys: [
@@ -149,16 +154,15 @@ class TransactionBuilder {
                     isSigner: false,
                     isWritable: true,
                 },
+                {
+                    pubkey: web3_js_1.SYSVAR_CLOCK_PUBKEY,
+                    isSigner: false,
+                    isWritable: false,
+                },
             ],
             data,
         });
     }
-    serializeOracle(oracle, serializer) {
-        const sequenceBuffer = buffer_1.Buffer.alloc(8);
-        sequenceBuffer.writeBigUInt64LE(oracle.sequence);
-        const payloadBuffer = serializer.serialize(oracle.payload);
-        return buffer_1.Buffer.concat([sequenceBuffer, payloadBuffer]);
-    }
 }
 exports.TransactionBuilder = TransactionBuilder;
 /**
@@ -201,15 +205,15 @@ class Doppler {
         if (data.length < expectedSize) {
             throw new Error(`Invalid oracle data size. Expected at least ${expectedSize}, got ${data.length}`);
         }
-        const sequence = data.readBigUInt64LE(0);
+        const slot = data.readBigUInt64LE(0);
         const payloadBuffer = data.subarray(8, 8 + serializer.size());
         const payload = serializer.deserialize(payloadBuffer);
-        return { sequence, payload };
+        return { slot, payload };
     }
     /**
      * Create an oracle account with a seed
      */
-    createOracleAccount(seed, serializer, initialOracle) {
+    createOracleAccount(seed, serializer) {
         return __awaiter(this, void 0, void 0, function* () {
             const oracleSize = 8 + serializer.size();
             const lamports = yield this.connection.getMinimumBalanceForRentExemption(oracleSize);
@@ -237,10 +241,10 @@ class Doppler {
     /**
      * Update a single oracle account
      */
-    updateOracle(oraclePubkey, oracle, serializer, unitPrice) {
+    updateOracle(oraclePubkey, payload, serializer, unitPrice) {
         return __awaiter(this, void 0, void 0, function* () {
             const recentBlockhash = yield this.connection.getLatestBlockhash();
-            let builder = this.createTransactionBuilder().addOracleUpdate(oraclePubkey, oracle, serializer);
+            let builder = this.createTransactionBuilder().addOracleUpdate(oraclePubkey, payload, serializer);
             if (unitPrice !== undefined) {
                 builder = builder.withUnitPrice(unitPrice);
             }
@@ -257,7 +261,7 @@ class Doppler {
             const recentBlockhash = yield this.connection.getLatestBlockhash();
             let builder = this.createTransactionBuilder();
             for (const update of updates) {
-                builder = builder.addOracleUpdate(update.oraclePubkey, update.oracle, update.serializer);
+                builder = builder.addOracleUpdate(update.oraclePubkey, update.payload, update.serializer);
             }
             if (unitPrice !== undefined) {
                 builder = builder.withUnitPrice(unitPrice);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reflectmoney/oracle.ts",
-  "version": "1.0.1",
+  "version": "2.1.0",
   "type": "commonjs",
   "author": "L0STE, stablecoinjesus @ Palindrome Engineering",
   "repository": {