bsv-x402 0.5.0 → 0.7.0

package/dist/index.d.cts

@@ -6,7 +6,7 @@ interface Challenge {
 }
 interface Proof {
     txid: string;
-    rawTx: string;
+    beef: string;
 }
 interface Brc105Challenge {
     version: string;
@@ -37,6 +37,11 @@ interface Brc105Wallet {
         hmac: number[];
     }>;
     createAction(params: CWICreateActionParams): Promise<CWICreateActionResult>;
+    abortAction?: (args: {
+        reference: string;
+    }) => Promise<{
+        aborted: boolean;
+    }>;
 }
 interface Brc105Proof {
     derivationPrefix: string;
@@ -45,46 +50,26 @@ interface Brc105Proof {
     clientIdentityKey: string;
     txid: string;
 }
-type Brc105ProofConstructor = (challenge: Brc105Challenge) => Promise<Brc105Proof>;
+interface Brc105ProofResult {
+    proof: Brc105Proof;
+    abort?: () => Promise<void>;
+}
+type Brc105ProofConstructor = (challenge: Brc105Challenge) => Promise<Brc105ProofResult>;
 type PaymentProtocol = 'x402' | 'brc105';
 interface PaymentRequest {
     amount: number;
     origin: string;
     protocol: PaymentProtocol;
 }
-type SpendMode = "interactive" | "programmatic";
-type TimeWindow = "minute" | "hour" | "day" | "week";
-interface WindowLimit {
-    window: TimeWindow;
-    maxSatoshis: number;
-    maxTransactions: number;
-}
-interface SpendLimits {
-    windows: WindowLimit[];
-    perTxMaxSatoshis: number;
-    yellowLightThreshold: number;
-    requirePerSitePrompt: boolean;
-    sitePolicies: Record<string, SitePolicy>;
-    require2fa: TwoFactorPolicy;
-}
-type SitePolicyAction = "global" | "custom" | "block";
-interface SitePolicy {
-    origin: string;
-    action: SitePolicyAction;
-    limits?: WindowLimit[];
-    perTxMaxSatoshis?: number;
-}
-interface TwoFactorPolicy {
-    onCircuitBreakerReset: boolean;
-    onTierChange: boolean;
-    onHighValueTx: boolean;
-    highValueThreshold: number;
-    onNewSiteApproval: boolean;
-}
 type TierName = "I'm Too Young to Die" | "Hey, Not Too Rough" | "Hurt Me Plenty" | "Ultra-Violence" | "Nightmare!";
-interface TierPreset {
-    interactive: SpendLimits;
-    programmatic: SpendLimits;
+type WeaponName = "Fists" | "Chainsaw" | "Pistol" | "Shotgun" | "Super Shotgun" | "Chaingun" | "Rocket Launcher" | "Plasma Rifle" | "BFG9000";
+type PickupName = "Medkit" | "Stimpak" | "Soul Sphere" | "New Game";
+interface AutospendConfig {
+    tier: TierName;
+    weapon: WeaponName;
+}
+interface AutospendState {
+    balance: number;
 }
 interface X402Config {
     proofConstructor?: (challenge: Challenge) => Promise<Proof>;
@@ -92,42 +77,6 @@ interface X402Config {
     brc105Wallet?: Brc105Wallet;
     onProofError?: (error: unknown, protocol: PaymentProtocol) => void;
 }
-interface YellowLightEvent {
-    origin: string;
-    currentSpend: number;
-    limit: number;
-    window: TimeWindow;
-    challenge: Challenge | PaymentRequest;
-}
-interface LedgerEntry {
-    timestamp: number;
-    origin: string;
-    satoshis: number;
-    txid: string;
-    protocol?: PaymentProtocol;
-}
-interface LimitState {
-    entries: LedgerEntry[];
-    circuitBroken: boolean;
-    hmac: string;
-}
-type BlockSeverity = "reject" | "window" | "trip";
-type LimitCheckResult = {
-    action: "allow";
-} | {
-    action: "yellow-light";
-    detail: YellowLightEvent;
-} | {
-    action: "block";
-    reason: string;
-    severity: BlockSeverity;
-};
-interface StorageAdapter {
-    load(): Promise<LimitState | null>;
-    save(state: LimitState): Promise<void>;
-    loadSitePolicies(): Promise<Record<string, SitePolicy>>;
-    saveSitePolicies(policies: Record<string, SitePolicy>): Promise<void>;
-}
 interface CWICreateActionOutput {
     satoshis: number;
     lockingScript: string;
@@ -150,28 +99,6 @@ interface CWICreateActionResult {
     rawTx?: string;
     tx?: number[];
 }
-type TwoFactorAction = {
-    type: "circuit-breaker-reset";
-} | {
-    type: "tier-change";
-    from: TierName;
-    to: TierName;
-} | {
-    type: "high-value-tx";
-    amount: number;
-    origin: string;
-} | {
-    type: "new-site-approval";
-    origin: string;
-} | {
-    type: "limit-override";
-    amount: number;
-    origin: string;
-    reason: string;
-};
-interface TwoFactorProvider {
-    verify(action: TwoFactorAction): Promise<boolean>;
-}
 
 type X402FetchFn = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 declare function createX402Fetch(config?: X402Config): X402FetchFn;
@@ -200,62 +127,46 @@ declare function parseBrc105Challenge(response: Response): Brc105Challenge;
  * 4. Call wallet.createAction with the locking script and custom instructions
  * 5. Convert transaction to base64
  */
-declare function constructBrc105Proof(challenge: Brc105Challenge, wallet: Brc105Wallet, origin?: string): Promise<Brc105Proof>;
-
-/** Anything with a numeric `amount` can be checked against spending limits. */
-type SpendCheckable = Challenge | PaymentRequest;
-declare const BFG_DAILY_CEILING_SATOSHIS = 10000000000;
-declare const BFG_PER_TX_CEILING_SATOSHIS = 1000000000;
-declare const TIER_PRESETS: Record<TierName, TierPreset>;
-declare function resolveSpendLimits(tier?: TierName, mode?: SpendMode, overrides?: Partial<SpendLimits>): SpendLimits;
-declare class RateLimiter {
-    private entries;
-    private limits;
-    private broken;
-    private now;
-    constructor(limits: SpendLimits, state?: LimitState, now?: () => number);
-    check(request: SpendCheckable, origin: string): LimitCheckResult;
-    record(entry: LedgerEntry): void;
-    trip(): void;
-    reset(): void;
-    isBroken(): boolean;
-    getState(): LimitState;
-    private hasCustomPolicy;
-    private effectiveWindows;
-    private effectivePerTxMax;
-    private entriesInWindow;
-    private sumSatoshis;
-    private prune;
-}
-
-type KeyDeriver = () => Promise<Uint8Array>;
-declare class LocalStorageAdapter implements StorageAdapter {
-    private keyDeriver?;
-    private storage;
-    constructor(keyDeriver?: KeyDeriver, storage?: Pick<Storage, "getItem" | "setItem">);
-    load(): Promise<LimitState | null>;
-    save(state: LimitState): Promise<void>;
-    loadSitePolicies(): Promise<Record<string, SitePolicy>>;
-    saveSitePolicies(policies: Record<string, SitePolicy>): Promise<void>;
-}
+declare function constructBrc105Proof(challenge: Brc105Challenge, wallet: Brc105Wallet, origin?: string): Promise<Brc105ProofResult>;
 
 /**
- * Wallet-based 2FA using BRC-100 createSignature().
- * The wallet's own approval UI (e.g. BSV Browser popup) serves as the 2FA prompt.
- * A malicious page script cannot forge a wallet signature.
+ * Autospend balance cap per tier (max sats that can be auto-spent without confirmation).
+ * Doom II difficulty progression — each tier is 10x the previous.
  */
-declare class WalletTwoFactorProvider implements TwoFactorProvider {
-    verify(action: TwoFactorAction): Promise<boolean>;
-    private promptFallback;
-}
-
-type SitePromptFn = (origin: string) => Promise<SitePolicyAction>;
+declare const TIER_CAPS: Record<TierName, number>;
+/**
+ * Per-tx max per weapon. BFG9000 has no hard cap — it's bound only by the
+ * autospend balance at payment time.
+ */
+declare const WEAPON_CAPS: Record<WeaponName, number>;
+/**
+ * Pickup percentages — how much of the tier cap each pickup restores.
+ */
+declare const PICKUP_PERCENTAGES: Record<PickupName, number>;
+type PaymentDecision = "auto" | "confirm";
+declare function checkPayment(amount: number, state: AutospendState, config: AutospendConfig): PaymentDecision;
+/**
+ * Deduct a payment from the autospend balance.
+ * Balance can never go below zero. Invalid amounts are ignored.
+ */
+declare function recordPayment(amount: number, state: AutospendState): AutospendState;
+/**
+ * Apply a pickup to the autospend state.
+ *
+ * - Medkit / Stimpak / Soul Sphere: add a percentage of tier cap to current balance
+ * - New Game: reset balance to tier cap (not additive)
+ *
+ * All pickups are capped by `min(tierCap, walletBalance)`.
+ */
+declare function applyPickup(pickup: PickupName, state: AutospendState, config: AutospendConfig, walletBalance: number): AutospendState;
+/**
+ * Clamp the autospend balance to the current tier cap and wallet balance.
+ * Used after a tier change to ensure the balance doesn't exceed the new cap.
+ */
+declare function clampBalanceToTier(state: AutospendState, config: AutospendConfig, walletBalance: number): AutospendState;
 /**
- * Resolves the site policy for a given origin.
- * If the origin already has a policy, returns it.
- * If not, and requirePerSitePrompt is true, prompts the user.
- * Otherwise falls back to global limits.
+ * Create a fresh autospend state at the tier cap.
  */
-declare function resolveSitePolicy(origin: string, limits: SpendLimits, twoFactorProvider?: TwoFactorProvider, promptFn?: SitePromptFn): Promise<SitePolicy>;
+declare function initialState(config: AutospendConfig, walletBalance: number): AutospendState;
 
-export { BFG_DAILY_CEILING_SATOSHIS, BFG_PER_TX_CEILING_SATOSHIS, type BlockSeverity, type Brc105Challenge, type Brc105Proof, type Brc105ProofConstructor, type Brc105Wallet, type CWICreateActionOutput, type CWICreateActionParams, type CWICreateActionResult, type Challenge, type KeyDeriver, type LedgerEntry, type LimitCheckResult, type LimitState, LocalStorageAdapter, type PaymentProtocol, type PaymentRequest, type Proof, RateLimiter, type SitePolicy, type SitePolicyAction, type SitePromptFn, type SpendCheckable, type SpendLimits, type SpendMode, type StorageAdapter, TIER_PRESETS, type TierName, type TierPreset, type TimeWindow, type TwoFactorAction, type TwoFactorPolicy, type TwoFactorProvider, WalletTwoFactorProvider, type WindowLimit, type X402Config, type X402FetchFn, type YellowLightEvent, constructBrc105Proof, createX402Fetch, parseBrc105Challenge, parseChallenge, resolveSitePolicy, resolveSpendLimits, x402Fetch };
+export { type AutospendConfig, type AutospendState, type Brc105Challenge, type Brc105Proof, type Brc105ProofConstructor, type Brc105Wallet, type CWICreateActionOutput, type CWICreateActionParams, type CWICreateActionResult, type Challenge, PICKUP_PERCENTAGES, type PaymentDecision, type PaymentProtocol, type PaymentRequest, type PickupName, type Proof, TIER_CAPS, type TierName, WEAPON_CAPS, type WeaponName, type X402Config, type X402FetchFn, applyPickup, checkPayment, clampBalanceToTier, constructBrc105Proof, createX402Fetch, initialState, parseBrc105Challenge, parseChallenge, recordPayment, x402Fetch };

package/dist/index.d.ts

@@ -6,7 +6,7 @@ interface Challenge {
 }
 interface Proof {
     txid: string;
-    rawTx: string;
+    beef: string;
 }
 interface Brc105Challenge {
     version: string;
@@ -37,6 +37,11 @@ interface Brc105Wallet {
         hmac: number[];
     }>;
     createAction(params: CWICreateActionParams): Promise<CWICreateActionResult>;
+    abortAction?: (args: {
+        reference: string;
+    }) => Promise<{
+        aborted: boolean;
+    }>;
 }
 interface Brc105Proof {
     derivationPrefix: string;
@@ -45,46 +50,26 @@ interface Brc105Proof {
     clientIdentityKey: string;
     txid: string;
 }
-type Brc105ProofConstructor = (challenge: Brc105Challenge) => Promise<Brc105Proof>;
+interface Brc105ProofResult {
+    proof: Brc105Proof;
+    abort?: () => Promise<void>;
+}
+type Brc105ProofConstructor = (challenge: Brc105Challenge) => Promise<Brc105ProofResult>;
 type PaymentProtocol = 'x402' | 'brc105';
 interface PaymentRequest {
     amount: number;
     origin: string;
     protocol: PaymentProtocol;
 }
-type SpendMode = "interactive" | "programmatic";
-type TimeWindow = "minute" | "hour" | "day" | "week";
-interface WindowLimit {
-    window: TimeWindow;
-    maxSatoshis: number;
-    maxTransactions: number;
-}
-interface SpendLimits {
-    windows: WindowLimit[];
-    perTxMaxSatoshis: number;
-    yellowLightThreshold: number;
-    requirePerSitePrompt: boolean;
-    sitePolicies: Record<string, SitePolicy>;
-    require2fa: TwoFactorPolicy;
-}
-type SitePolicyAction = "global" | "custom" | "block";
-interface SitePolicy {
-    origin: string;
-    action: SitePolicyAction;
-    limits?: WindowLimit[];
-    perTxMaxSatoshis?: number;
-}
-interface TwoFactorPolicy {
-    onCircuitBreakerReset: boolean;
-    onTierChange: boolean;
-    onHighValueTx: boolean;
-    highValueThreshold: number;
-    onNewSiteApproval: boolean;
-}
 type TierName = "I'm Too Young to Die" | "Hey, Not Too Rough" | "Hurt Me Plenty" | "Ultra-Violence" | "Nightmare!";
-interface TierPreset {
-    interactive: SpendLimits;
-    programmatic: SpendLimits;
+type WeaponName = "Fists" | "Chainsaw" | "Pistol" | "Shotgun" | "Super Shotgun" | "Chaingun" | "Rocket Launcher" | "Plasma Rifle" | "BFG9000";
+type PickupName = "Medkit" | "Stimpak" | "Soul Sphere" | "New Game";
+interface AutospendConfig {
+    tier: TierName;
+    weapon: WeaponName;
+}
+interface AutospendState {
+    balance: number;
 }
 interface X402Config {
     proofConstructor?: (challenge: Challenge) => Promise<Proof>;
@@ -92,42 +77,6 @@ interface X402Config {
     brc105Wallet?: Brc105Wallet;
     onProofError?: (error: unknown, protocol: PaymentProtocol) => void;
 }
-interface YellowLightEvent {
-    origin: string;
-    currentSpend: number;
-    limit: number;
-    window: TimeWindow;
-    challenge: Challenge | PaymentRequest;
-}
-interface LedgerEntry {
-    timestamp: number;
-    origin: string;
-    satoshis: number;
-    txid: string;
-    protocol?: PaymentProtocol;
-}
-interface LimitState {
-    entries: LedgerEntry[];
-    circuitBroken: boolean;
-    hmac: string;
-}
-type BlockSeverity = "reject" | "window" | "trip";
-type LimitCheckResult = {
-    action: "allow";
-} | {
-    action: "yellow-light";
-    detail: YellowLightEvent;
-} | {
-    action: "block";
-    reason: string;
-    severity: BlockSeverity;
-};
-interface StorageAdapter {
-    load(): Promise<LimitState | null>;
-    save(state: LimitState): Promise<void>;
-    loadSitePolicies(): Promise<Record<string, SitePolicy>>;
-    saveSitePolicies(policies: Record<string, SitePolicy>): Promise<void>;
-}
 interface CWICreateActionOutput {
     satoshis: number;
     lockingScript: string;
@@ -150,28 +99,6 @@ interface CWICreateActionResult {
     rawTx?: string;
     tx?: number[];
 }
-type TwoFactorAction = {
-    type: "circuit-breaker-reset";
-} | {
-    type: "tier-change";
-    from: TierName;
-    to: TierName;
-} | {
-    type: "high-value-tx";
-    amount: number;
-    origin: string;
-} | {
-    type: "new-site-approval";
-    origin: string;
-} | {
-    type: "limit-override";
-    amount: number;
-    origin: string;
-    reason: string;
-};
-interface TwoFactorProvider {
-    verify(action: TwoFactorAction): Promise<boolean>;
-}
 
 type X402FetchFn = (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;
 declare function createX402Fetch(config?: X402Config): X402FetchFn;
@@ -200,62 +127,46 @@ declare function parseBrc105Challenge(response: Response): Brc105Challenge;
  * 4. Call wallet.createAction with the locking script and custom instructions
  * 5. Convert transaction to base64
  */
-declare function constructBrc105Proof(challenge: Brc105Challenge, wallet: Brc105Wallet, origin?: string): Promise<Brc105Proof>;
-
-/** Anything with a numeric `amount` can be checked against spending limits. */
-type SpendCheckable = Challenge | PaymentRequest;
-declare const BFG_DAILY_CEILING_SATOSHIS = 10000000000;
-declare const BFG_PER_TX_CEILING_SATOSHIS = 1000000000;
-declare const TIER_PRESETS: Record<TierName, TierPreset>;
-declare function resolveSpendLimits(tier?: TierName, mode?: SpendMode, overrides?: Partial<SpendLimits>): SpendLimits;
-declare class RateLimiter {
-    private entries;
-    private limits;
-    private broken;
-    private now;
-    constructor(limits: SpendLimits, state?: LimitState, now?: () => number);
-    check(request: SpendCheckable, origin: string): LimitCheckResult;
-    record(entry: LedgerEntry): void;
-    trip(): void;
-    reset(): void;
-    isBroken(): boolean;
-    getState(): LimitState;
-    private hasCustomPolicy;
-    private effectiveWindows;
-    private effectivePerTxMax;
-    private entriesInWindow;
-    private sumSatoshis;
-    private prune;
-}
-
-type KeyDeriver = () => Promise<Uint8Array>;
-declare class LocalStorageAdapter implements StorageAdapter {
-    private keyDeriver?;
-    private storage;
-    constructor(keyDeriver?: KeyDeriver, storage?: Pick<Storage, "getItem" | "setItem">);
-    load(): Promise<LimitState | null>;
-    save(state: LimitState): Promise<void>;
-    loadSitePolicies(): Promise<Record<string, SitePolicy>>;
-    saveSitePolicies(policies: Record<string, SitePolicy>): Promise<void>;
-}
+declare function constructBrc105Proof(challenge: Brc105Challenge, wallet: Brc105Wallet, origin?: string): Promise<Brc105ProofResult>;
 
 /**
- * Wallet-based 2FA using BRC-100 createSignature().
- * The wallet's own approval UI (e.g. BSV Browser popup) serves as the 2FA prompt.
- * A malicious page script cannot forge a wallet signature.
+ * Autospend balance cap per tier (max sats that can be auto-spent without confirmation).
+ * Doom II difficulty progression — each tier is 10x the previous.
  */
-declare class WalletTwoFactorProvider implements TwoFactorProvider {
-    verify(action: TwoFactorAction): Promise<boolean>;
-    private promptFallback;
-}
-
-type SitePromptFn = (origin: string) => Promise<SitePolicyAction>;
+declare const TIER_CAPS: Record<TierName, number>;
+/**
+ * Per-tx max per weapon. BFG9000 has no hard cap — it's bound only by the
+ * autospend balance at payment time.
+ */
+declare const WEAPON_CAPS: Record<WeaponName, number>;
+/**
+ * Pickup percentages — how much of the tier cap each pickup restores.
+ */
+declare const PICKUP_PERCENTAGES: Record<PickupName, number>;
+type PaymentDecision = "auto" | "confirm";
+declare function checkPayment(amount: number, state: AutospendState, config: AutospendConfig): PaymentDecision;
+/**
+ * Deduct a payment from the autospend balance.
+ * Balance can never go below zero. Invalid amounts are ignored.
+ */
+declare function recordPayment(amount: number, state: AutospendState): AutospendState;
+/**
+ * Apply a pickup to the autospend state.
+ *
+ * - Medkit / Stimpak / Soul Sphere: add a percentage of tier cap to current balance
+ * - New Game: reset balance to tier cap (not additive)
+ *
+ * All pickups are capped by `min(tierCap, walletBalance)`.
+ */
+declare function applyPickup(pickup: PickupName, state: AutospendState, config: AutospendConfig, walletBalance: number): AutospendState;
+/**
+ * Clamp the autospend balance to the current tier cap and wallet balance.
+ * Used after a tier change to ensure the balance doesn't exceed the new cap.
+ */
+declare function clampBalanceToTier(state: AutospendState, config: AutospendConfig, walletBalance: number): AutospendState;
 /**
- * Resolves the site policy for a given origin.
- * If the origin already has a policy, returns it.
- * If not, and requirePerSitePrompt is true, prompts the user.
- * Otherwise falls back to global limits.
+ * Create a fresh autospend state at the tier cap.
  */
-declare function resolveSitePolicy(origin: string, limits: SpendLimits, twoFactorProvider?: TwoFactorProvider, promptFn?: SitePromptFn): Promise<SitePolicy>;
+declare function initialState(config: AutospendConfig, walletBalance: number): AutospendState;
 
-export { BFG_DAILY_CEILING_SATOSHIS, BFG_PER_TX_CEILING_SATOSHIS, type BlockSeverity, type Brc105Challenge, type Brc105Proof, type Brc105ProofConstructor, type Brc105Wallet, type CWICreateActionOutput, type CWICreateActionParams, type CWICreateActionResult, type Challenge, type KeyDeriver, type LedgerEntry, type LimitCheckResult, type LimitState, LocalStorageAdapter, type PaymentProtocol, type PaymentRequest, type Proof, RateLimiter, type SitePolicy, type SitePolicyAction, type SitePromptFn, type SpendCheckable, type SpendLimits, type SpendMode, type StorageAdapter, TIER_PRESETS, type TierName, type TierPreset, type TimeWindow, type TwoFactorAction, type TwoFactorPolicy, type TwoFactorProvider, WalletTwoFactorProvider, type WindowLimit, type X402Config, type X402FetchFn, type YellowLightEvent, constructBrc105Proof, createX402Fetch, parseBrc105Challenge, parseChallenge, resolveSitePolicy, resolveSpendLimits, x402Fetch };
+export { type AutospendConfig, type AutospendState, type Brc105Challenge, type Brc105Proof, type Brc105ProofConstructor, type Brc105Wallet, type CWICreateActionOutput, type CWICreateActionParams, type CWICreateActionResult, type Challenge, PICKUP_PERCENTAGES, type PaymentDecision, type PaymentProtocol, type PaymentRequest, type PickupName, type Proof, TIER_CAPS, type TierName, WEAPON_CAPS, type WeaponName, type X402Config, type X402FetchFn, applyPickup, checkPayment, clampBalanceToTier, constructBrc105Proof, createX402Fetch, initialState, parseBrc105Challenge, parseChallenge, recordPayment, x402Fetch };