@reflectmoney/oracle.ts 1.0.0 → 2.0.0

package/README.md

@@ -0,0 +1,100 @@
+# @reflectmoney/oracle.ts
+
+TypeScript SDK for Doppler, the efficient oracle program implemented by [Blueshift](https://blueshift.gg), used by Reflect.
+
+## About
+
+Reflect uses [Doppler](https://github.com/blueshift-gg/doppler) as its oracle solution, enabling oracle updates with just **21 compute units** per call - one of the most efficient implementations on Solana.
+
+**Program ID:** `PRicevBH6BaeaE8qmrxrwGBZ5hSZ9vjBNue5Ygot1ML`
+
+## Installation
+
+With NPM:
+```bash
+npm install @reflectmoney/oracle.ts
+```
+
+With Yarn:
+```bash
+yarn add @reflectmoney/oracle.ts
+```
+
+## Usage
+
+### Initialize Doppler
+
+```typescript
+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");
+const admin = Keypair.fromSecretKey(/* admin keypair */);
+
+const doppler = new Doppler(connection, admin);
+```
+
+### Update an Oracle
+
+```typescript
+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,
+    { 
+        slot: BigInt(Date.now()),
+        payload: pricePayload,
+    },
+    new U8Array8Serializer(),
+);
+```
+
+### Fetch Oracle Data
+
+```typescript
+import { readPriceFromPayload } from "@reflectmoney/oracle.ts";
+
+const oracleData = await doppler.fetchOracle(
+    oraclePublicKey,
+    new U8Array8Serializer(),
+);
+
+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
+
+```typescript
+const oracleAccount = await doppler.createOracleAccount(
+    "my-oracle-seed",
+    new U8Array8Serializer(), 
+    { 
+        slot: 0n,
+        payload: createPricePayload(BigInt(1_000_000)),
+    }
+);
+```
+
+## Links
+
+- [GitHub Repository](https://github.com/palindrome-eng/doppler)
+- [Reflect](https://reflect.money)
+
+## License
+
+MIT
+

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
  */

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
  */
@@ -83,7 +88,7 @@ class TransactionBuilder {
     addOracleUpdate(oraclePubkey, oracle, serializer) {
         const instruction = this.createUpdateInstruction(oraclePubkey, oracle, 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 +
@@ -149,15 +154,20 @@ 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 slotBuffer = buffer_1.Buffer.alloc(8);
+        slotBuffer.writeBigUInt64LE(oracle.slot);
         const payloadBuffer = serializer.serialize(oracle.payload);
-        return buffer_1.Buffer.concat([sequenceBuffer, payloadBuffer]);
+        return buffer_1.Buffer.concat([slotBuffer, payloadBuffer]);
     }
 }
 exports.TransactionBuilder = TransactionBuilder;
@@ -201,10 +211,10 @@ 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

package/package.json

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