hyperstack-stacks 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hypertek
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,93 @@
+# hyperstack-stacks
+
+[![npm](https://img.shields.io/npm/v/hyperstack-stacks.svg)](https://www.npmjs.com/package/hyperstack-stacks)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+Protocol stacks for Hyperstack - ready-to-use Solana data streams.
+
+## Installation
+
+```bash
+npm install hyperstack-stacks
+```
+
+## Usage
+
+### With hyperstack-react
+
+```tsx
+import { useHyperstack } from 'hyperstack-react';
+import { PUMPFUNTOKEN_STACK } from 'hyperstack-stacks/pumpfun';
+
+function TokenList() {
+  const hs = useHyperstack(PUMPFUNTOKEN_STACK);
+  const tokens = hs.views.pumpfunToken.list.useWatch();
+
+  return (
+    <ul>
+      {tokens.map((token) => (
+        <li key={token.id?.mint}>
+          {token.info?.name} - {token.info?.symbol}
+        </li>
+      ))}
+    </ul>
+  );
+}
+```
+
+### With hyperstack-typescript (framework-agnostic)
+
+```typescript
+import { HyperStack } from 'hyperstack-typescript';
+import { PUMPFUNTOKEN_STACK, PumpfunToken } from 'hyperstack-stacks/pumpfun';
+
+const hs = await HyperStack.connect('wss://mainnet.hyperstack.xyz', {
+  stack: PUMPFUNTOKEN_STACK,
+});
+
+// Stream all token updates
+for await (const update of hs.views.pumpfunToken.list.watch()) {
+  if (update.type === 'upsert') {
+    console.log('Token updated:', update.data.info?.name);
+  }
+}
+```
+
+## Available Stacks
+
+### PumpFun Token Stack
+
+Real-time streaming data for PumpFun tokens on Solana.
+
+```typescript
+import { PUMPFUNTOKEN_STACK, PumpfunToken } from 'hyperstack-stacks/pumpfun';
+```
+
+**Entity: `PumpfunToken`**
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | `PumpfunTokenId` | Token identifiers (mint, bonding curve) |
+| `info` | `PumpfunTokenInfo` | Token metadata (name, symbol, URI) |
+| `reserves` | `PumpfunTokenReserves` | Current reserve state and pricing |
+| `trading` | `PumpfunTokenTrading` | Trading statistics and metrics |
+| `events` | `PumpfunTokenEvents` | Recent buy/sell/create events |
+
+## Peer Dependencies
+
+This package requires one of:
+
+- `hyperstack-react` - For React applications
+- `hyperstack-typescript` - For framework-agnostic usage
+
+```bash
+# For React
+npm install hyperstack-react hyperstack-stacks
+
+# For vanilla TypeScript/JavaScript
+npm install hyperstack-typescript hyperstack-stacks
+```
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,46 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  PUMPFUNTOKEN_STACK: () => PUMPFUNTOKEN_STACK
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/pumpfun/index.ts
+function stateView(view) {
+  return { mode: "state", view };
+}
+function listView(view) {
+  return { mode: "list", view };
+}
+var PUMPFUNTOKEN_STACK = {
+  name: "pumpfun-token",
+  views: {
+    pumpfunToken: {
+      state: stateView("PumpfunToken/state"),
+      list: listView("PumpfunToken/list")
+    }
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PUMPFUNTOKEN_STACK
+});

package/dist/index.d.cts

@@ -0,0 +1 @@
+export { BondingCurve, Buy, BuysEvent, Create, CreateEvent, EventWrapper, default as PUMPFUNTOKEN_STACK, PumpfunToken, PumpfunTokenEvents, PumpfunTokenId, PumpfunTokenInfo, PumpfunTokenReserves, PumpfunTokenStack, PumpfunTokenTrading, Sell, SellsEvent, ViewDef } from './pumpfun/index.cjs';

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { BondingCurve, Buy, BuysEvent, Create, CreateEvent, EventWrapper, default as PUMPFUNTOKEN_STACK, PumpfunToken, PumpfunTokenEvents, PumpfunTokenId, PumpfunTokenInfo, PumpfunTokenReserves, PumpfunTokenStack, PumpfunTokenTrading, Sell, SellsEvent, ViewDef } from './pumpfun/index.js';

package/dist/index.js

@@ -0,0 +1,19 @@
+// src/pumpfun/index.ts
+function stateView(view) {
+  return { mode: "state", view };
+}
+function listView(view) {
+  return { mode: "list", view };
+}
+var PUMPFUNTOKEN_STACK = {
+  name: "pumpfun-token",
+  views: {
+    pumpfunToken: {
+      state: stateView("PumpfunToken/state"),
+      list: listView("PumpfunToken/list")
+    }
+  }
+};
+export {
+  PUMPFUNTOKEN_STACK
+};

package/dist/pumpfun/index.cjs

@@ -0,0 +1,46 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/pumpfun/index.ts
+var pumpfun_exports = {};
+__export(pumpfun_exports, {
+  PUMPFUNTOKEN_STACK: () => PUMPFUNTOKEN_STACK,
+  default: () => pumpfun_default
+});
+module.exports = __toCommonJS(pumpfun_exports);
+function stateView(view) {
+  return { mode: "state", view };
+}
+function listView(view) {
+  return { mode: "list", view };
+}
+var PUMPFUNTOKEN_STACK = {
+  name: "pumpfun-token",
+  views: {
+    pumpfunToken: {
+      state: stateView("PumpfunToken/state"),
+      list: listView("PumpfunToken/list")
+    }
+  }
+};
+var pumpfun_default = PUMPFUNTOKEN_STACK;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PUMPFUNTOKEN_STACK
+});

package/dist/pumpfun/index.d.cts

@@ -0,0 +1,152 @@
+interface PumpfunTokenEvents {
+    buys?: EventWrapper<Buy>[];
+    create?: Create | null;
+    sells?: EventWrapper<Sell>[];
+}
+interface PumpfunTokenId {
+    bondingCurve?: string;
+    mint?: string;
+}
+interface PumpfunTokenInfo {
+    isComplete?: boolean | null;
+    name?: string | null;
+    symbol?: string | null;
+    uri?: string | null;
+}
+interface PumpfunTokenReserves {
+    currentPriceSol?: number | null;
+    marketCapSol?: number | null;
+    realSolReserves?: number | null;
+    realTokenReserves?: number | null;
+    tokenTotalSupply?: number | null;
+    virtualSolReserves?: number | null;
+    virtualTokenReserves?: number | null;
+}
+interface PumpfunTokenTrading {
+    averageTradeSize?: number | null;
+    buyCount?: number | null;
+    largestTrade?: number | null;
+    lastTradePrice?: number | null;
+    lastTradeTimestamp?: number | null;
+    lastWhaleAddress?: string | null;
+    sellCount?: number | null;
+    smallestTrade?: number | null;
+    totalBuyVolume?: number | null;
+    totalSellVolume?: number | null;
+    totalTrades?: number | null;
+    totalVolume?: number | null;
+    uniqueTraders?: number | null;
+    whaleTradeCount?: number | null;
+}
+interface PumpfunToken {
+    events?: PumpfunTokenEvents;
+    id?: PumpfunTokenId;
+    info?: PumpfunTokenInfo;
+    reserves?: PumpfunTokenReserves;
+    trading?: PumpfunTokenTrading;
+    bondingCurveSnapshot?: BondingCurve | null;
+}
+interface Create {
+    mint?: string;
+    mintAuthority?: string;
+    bondingCurve?: string;
+    associatedBondingCurve?: string;
+    global?: string;
+    mplTokenMetadata?: string;
+    metadata?: string;
+    user?: string;
+    systemProgram?: string;
+    tokenProgram?: string;
+    associatedTokenProgram?: string;
+    rent?: string;
+    eventAuthority?: string;
+    program?: string;
+    name?: string;
+    symbol?: string;
+    uri?: string;
+    creator?: string;
+}
+interface Buy {
+    global?: string;
+    feeRecipient?: string;
+    mint?: string;
+    bondingCurve?: string;
+    associatedBondingCurve?: string;
+    associatedUser?: string;
+    user?: string;
+    systemProgram?: string;
+    tokenProgram?: string;
+    creatorVault?: string;
+    eventAuthority?: string;
+    program?: string;
+    amount?: number;
+    maxSolCost?: number;
+}
+interface Sell {
+    global?: string;
+    feeRecipient?: string;
+    mint?: string;
+    bondingCurve?: string;
+    associatedBondingCurve?: string;
+    associatedUser?: string;
+    user?: string;
+    systemProgram?: string;
+    creatorVault?: string;
+    tokenProgram?: string;
+    eventAuthority?: string;
+    program?: string;
+    amount?: number;
+    minSolOutput?: number;
+}
+interface BondingCurve {
+    virtualTokenReserves?: number;
+    virtualSolReserves?: number;
+    realTokenReserves?: number;
+    realSolReserves?: number;
+    tokenTotalSupply?: number;
+    complete?: boolean;
+    creator?: string;
+}
+interface BuysEvent {
+    amount: number;
+    maxSolCost: number;
+}
+interface CreateEvent {
+}
+interface SellsEvent {
+}
+/**
+ * Wrapper for event data that includes context metadata.
+ * Events are automatically wrapped in this structure at runtime.
+ */
+interface EventWrapper<T> {
+    /** Unix timestamp when the event was processed */
+    timestamp: number;
+    /** The event-specific data */
+    data: T;
+    /** Optional blockchain slot number */
+    slot?: number;
+    /** Optional transaction signature */
+    signature?: string;
+}
+/** View definition with embedded entity type */
+interface ViewDef<T, TMode extends 'state' | 'list'> {
+    readonly mode: TMode;
+    readonly view: string;
+    /** Phantom field for type inference - not present at runtime */
+    readonly _entity?: T;
+}
+/** Stack definition for PumpfunToken */
+declare const PUMPFUNTOKEN_STACK: {
+    readonly name: "pumpfun-token";
+    readonly views: {
+        readonly pumpfunToken: {
+            readonly state: ViewDef<PumpfunToken, "state">;
+            readonly list: ViewDef<PumpfunToken, "list">;
+        };
+    };
+};
+/** Type alias for the stack */
+type PumpfunTokenStack = typeof PUMPFUNTOKEN_STACK;
+
+export { type BondingCurve, type Buy, type BuysEvent, type Create, type CreateEvent, type EventWrapper, PUMPFUNTOKEN_STACK, type PumpfunToken, type PumpfunTokenEvents, type PumpfunTokenId, type PumpfunTokenInfo, type PumpfunTokenReserves, type PumpfunTokenStack, type PumpfunTokenTrading, type Sell, type SellsEvent, type ViewDef, PUMPFUNTOKEN_STACK as default };

package/dist/pumpfun/index.d.ts

@@ -0,0 +1,152 @@
+interface PumpfunTokenEvents {
+    buys?: EventWrapper<Buy>[];
+    create?: Create | null;
+    sells?: EventWrapper<Sell>[];
+}
+interface PumpfunTokenId {
+    bondingCurve?: string;
+    mint?: string;
+}
+interface PumpfunTokenInfo {
+    isComplete?: boolean | null;
+    name?: string | null;
+    symbol?: string | null;
+    uri?: string | null;
+}
+interface PumpfunTokenReserves {
+    currentPriceSol?: number | null;
+    marketCapSol?: number | null;
+    realSolReserves?: number | null;
+    realTokenReserves?: number | null;
+    tokenTotalSupply?: number | null;
+    virtualSolReserves?: number | null;
+    virtualTokenReserves?: number | null;
+}
+interface PumpfunTokenTrading {
+    averageTradeSize?: number | null;
+    buyCount?: number | null;
+    largestTrade?: number | null;
+    lastTradePrice?: number | null;
+    lastTradeTimestamp?: number | null;
+    lastWhaleAddress?: string | null;
+    sellCount?: number | null;
+    smallestTrade?: number | null;
+    totalBuyVolume?: number | null;
+    totalSellVolume?: number | null;
+    totalTrades?: number | null;
+    totalVolume?: number | null;
+    uniqueTraders?: number | null;
+    whaleTradeCount?: number | null;
+}
+interface PumpfunToken {
+    events?: PumpfunTokenEvents;
+    id?: PumpfunTokenId;
+    info?: PumpfunTokenInfo;
+    reserves?: PumpfunTokenReserves;
+    trading?: PumpfunTokenTrading;
+    bondingCurveSnapshot?: BondingCurve | null;
+}
+interface Create {
+    mint?: string;
+    mintAuthority?: string;
+    bondingCurve?: string;
+    associatedBondingCurve?: string;
+    global?: string;
+    mplTokenMetadata?: string;
+    metadata?: string;
+    user?: string;
+    systemProgram?: string;
+    tokenProgram?: string;
+    associatedTokenProgram?: string;
+    rent?: string;
+    eventAuthority?: string;
+    program?: string;
+    name?: string;
+    symbol?: string;
+    uri?: string;
+    creator?: string;
+}
+interface Buy {
+    global?: string;
+    feeRecipient?: string;
+    mint?: string;
+    bondingCurve?: string;
+    associatedBondingCurve?: string;
+    associatedUser?: string;
+    user?: string;
+    systemProgram?: string;
+    tokenProgram?: string;
+    creatorVault?: string;
+    eventAuthority?: string;
+    program?: string;
+    amount?: number;
+    maxSolCost?: number;
+}
+interface Sell {
+    global?: string;
+    feeRecipient?: string;
+    mint?: string;
+    bondingCurve?: string;
+    associatedBondingCurve?: string;
+    associatedUser?: string;
+    user?: string;
+    systemProgram?: string;
+    creatorVault?: string;
+    tokenProgram?: string;
+    eventAuthority?: string;
+    program?: string;
+    amount?: number;
+    minSolOutput?: number;
+}
+interface BondingCurve {
+    virtualTokenReserves?: number;
+    virtualSolReserves?: number;
+    realTokenReserves?: number;
+    realSolReserves?: number;
+    tokenTotalSupply?: number;
+    complete?: boolean;
+    creator?: string;
+}
+interface BuysEvent {
+    amount: number;
+    maxSolCost: number;
+}
+interface CreateEvent {
+}
+interface SellsEvent {
+}
+/**
+ * Wrapper for event data that includes context metadata.
+ * Events are automatically wrapped in this structure at runtime.
+ */
+interface EventWrapper<T> {
+    /** Unix timestamp when the event was processed */
+    timestamp: number;
+    /** The event-specific data */
+    data: T;
+    /** Optional blockchain slot number */
+    slot?: number;
+    /** Optional transaction signature */
+    signature?: string;
+}
+/** View definition with embedded entity type */
+interface ViewDef<T, TMode extends 'state' | 'list'> {
+    readonly mode: TMode;
+    readonly view: string;
+    /** Phantom field for type inference - not present at runtime */
+    readonly _entity?: T;
+}
+/** Stack definition for PumpfunToken */
+declare const PUMPFUNTOKEN_STACK: {
+    readonly name: "pumpfun-token";
+    readonly views: {
+        readonly pumpfunToken: {
+            readonly state: ViewDef<PumpfunToken, "state">;
+            readonly list: ViewDef<PumpfunToken, "list">;
+        };
+    };
+};
+/** Type alias for the stack */
+type PumpfunTokenStack = typeof PUMPFUNTOKEN_STACK;
+
+export { type BondingCurve, type Buy, type BuysEvent, type Create, type CreateEvent, type EventWrapper, PUMPFUNTOKEN_STACK, type PumpfunToken, type PumpfunTokenEvents, type PumpfunTokenId, type PumpfunTokenInfo, type PumpfunTokenReserves, type PumpfunTokenStack, type PumpfunTokenTrading, type Sell, type SellsEvent, type ViewDef, PUMPFUNTOKEN_STACK as default };

package/dist/pumpfun/index.js

@@ -0,0 +1,21 @@
+// src/pumpfun/index.ts
+function stateView(view) {
+  return { mode: "state", view };
+}
+function listView(view) {
+  return { mode: "list", view };
+}
+var PUMPFUNTOKEN_STACK = {
+  name: "pumpfun-token",
+  views: {
+    pumpfunToken: {
+      state: stateView("PumpfunToken/state"),
+      list: listView("PumpfunToken/list")
+    }
+  }
+};
+var pumpfun_default = PUMPFUNTOKEN_STACK;
+export {
+  PUMPFUNTOKEN_STACK,
+  pumpfun_default as default
+};

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "hyperstack-stacks",
+  "version": "0.3.0",
+  "description": "Protocol stacks for Hyperstack - ready-to-use Solana data streams",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./pumpfun": {
+      "types": "./dist/pumpfun/index.d.ts",
+      "import": "./dist/pumpfun/index.js",
+      "require": "./dist/pumpfun/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "hyperstack-react": ">=0.2.0",
+    "hyperstack-typescript": ">=0.2.0"
+  },
+  "peerDependenciesMeta": {
+    "hyperstack-react": {
+      "optional": true
+    },
+    "hyperstack-typescript": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "keywords": [
+    "hyperstack",
+    "solana",
+    "blockchain",
+    "streaming",
+    "pumpfun"
+  ],
+  "author": "HyperTek",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/HyperTekOrg/hyperstack.git",
+    "directory": "stacks/sdk/typescript"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}