Price-Based Locks

import { SolanaStreamClient, ICluster } from "@streamflow/stream";
import { Keypair } from "@solana/web3.js";
import BN from "bn.js";
import fs from "node:fs";

const client = new SolanaStreamClient({
  clusterUrl: "https://api.mainnet-beta.solana.com",
  cluster: ICluster.Mainnet,
});

const secret = JSON.parse(fs.readFileSync(process.env.KEYPAIR_PATH!, "utf-8"));
const invoker = Keypair.fromSecretKey(Uint8Array.from(secret));

const start = Math.floor(Date.now() / 1000);

const { txId, metadataId } = await client.create(
  {
    recipient: "RecipientWalletAddress...",
    tokenId: "TokenMintAddress...",
    amount: new BN(1_000_000_000), // 1000 tokens at 6 decimals

    // Schedule - price-based lock uses a single synthetic period
    start,
    cliff: start,
    period: 1,
    cliffAmount: new BN(1_000_000_000).subn(1), // amount - 1
    amountPerPeriod: new BN(1),                  // dust amount

    // Lock flags - all hardcoded false for locks
    canTopup: false,
    cancelableBySender: false,
    cancelableByRecipient: false,
    transferableBySender: false,
    transferableByRecipient: false,
    automaticWithdrawal: false,
    withdrawalFrequency: 0,

    name: "Price Lock - Unlock at $5",

    // Price oracle configuration - all four fields required for lock classification
    maxPrice: 5,            // unlock when oracle price >= $5
    minPrice: 4,            // must be maxPrice - 1
    minPercentage: 0,       // must be 0 for lock classification
    maxPercentage: 100,     // must be 100 for lock classification
    oracleType: "pyth",     // or "switchboard"
    // Pyth SOL/USD feed on mainnet:
    priceOracle: "H6ARHf6YXhGYeQfUzQNGk6rDNnLBQKrenN712K4AQJEG",
  },
  {
    sender: invoker,
    isNative: false,
  },
);

console.log("Price lock stream ID:", metadataId);
console.log("Transaction:", txId);

import { StreamType, isAligned } from "@streamflow/stream";

const stream = await client.getOne({ id: metadataId });
console.log("Is lock:", stream.type === StreamType.Lock);  // true
console.log("Is price-based:", stream.isAligned);          // true

if (isAligned(stream)) {
  // AlignedStream - price fields are now available
  console.log("Max price:", stream.maxPrice);              // 5
  console.log("Oracle type:", stream.oracleType);          // "pyth"
  console.log("Oracle:", stream.priceOracle);
}