@bsv/btms-permission-module 1.0.0

package/src/index.ts

@@ -0,0 +1,28 @@
+/**
+ * BTMS Permission Module (Core)
+ * 
+ * Provides wallet permission module for BTMS token spending authorization.
+ * This is the core module without UI dependencies - framework agnostic.
+ * 
+ * For React/MUI UI components, see @bsv/btms-permission-module-ui
+ */
+
+import type { WalletInterface } from '@bsv/sdk'
+import { BTMS } from '@bsv/btms'
+import { BasicTokenModule } from './BasicTokenModule.js'
+
+export type PermissionPromptHandler = (app: string, message: string) => Promise<boolean>
+
+export type PermissionModuleFactoryArgs = {
+  wallet: WalletInterface
+  promptHandler?: PermissionPromptHandler
+}
+
+const denyPrompt: PermissionPromptHandler = async () => false
+
+export const createBtmsModule = ({ wallet, promptHandler }: PermissionModuleFactoryArgs) => {
+  const btms = new BTMS({ wallet, networkPreset: 'local' })
+  return new BasicTokenModule(promptHandler ?? denyPrompt, btms)
+}
+
+export { BasicTokenModule }

package/src/types.ts

@@ -0,0 +1,81 @@
+// ---------------------------------------------------------------------------
+// BTMS Permission Module Constants and Types
+// ---------------------------------------------------------------------------
+// BRC-99: Baskets prefixed with "p " are permissioned and require wallet
+// permission module support. The scheme ID is "btms".
+//
+// Token basket format: "p btms <assetId>"
+// Example: "p btms abc123def456.0"
+// ---------------------------------------------------------------------------
+
+/** Permissioned basket prefix - aligns with btms-core */
+export const P_BASKET_PREFIX = 'p btms'
+
+/** Literal used in field[0] to indicate token issuance - aligns with btms-core */
+export const ISSUE_MARKER = 'ISSUE'
+
+/** Index positions for BTMS PushDrop token fields */
+export const BTMS_FIELD = {
+  ASSET_ID: 0,
+  AMOUNT: 1,
+  METADATA: 2
+} as const
+
+/**
+ * Parsed information about a BTMS token from its locking script
+ */
+export interface ParsedTokenInfo {
+  assetId: string
+  amount: number
+  metadata?: {
+    name?: string
+    description?: string
+    iconURL?: string
+    [key: string]: unknown
+  }
+}
+
+/**
+ * Comprehensive token spend information extracted from createAction args
+ */
+export interface TokenSpendInfo {
+  /** Total amount being sent to recipient (not including change) */
+  sendAmount: number
+  /** Total amount being spent from inputs */
+  totalInputAmount: number
+  /** Change amount (totalInputAmount - sendAmount) */
+  changeAmount: number
+  /** Total amount sent in token outputs (derived from outputs) */
+  outputSendAmount: number
+  /** Total amount returned as change in token outputs (derived from outputs) */
+  outputChangeAmount: number
+  /** Whether any token outputs were parsed */
+  hasTokenOutputs: boolean
+  /** Source of totalInputAmount */
+  inputAmountSource: 'beef' | 'descriptions' | 'derived' | 'none'
+  /** Token name from metadata */
+  tokenName: string
+  /** Asset ID */
+  assetId: string
+  /** Recipient identity key (truncated) */
+  recipient?: string
+  /** Token icon URL if available */
+  iconURL?: string
+  /** Full action description */
+  actionDescription: string
+}
+
+/**
+ * Authorized transaction data captured from createAction response.
+ * Used to verify createSignature calls are signing what was actually authorized.
+ */
+export interface AuthorizedTransaction {
+  /** The reference from the signable transaction */
+  reference: string
+  /** Hash of all outputs (BIP-143 hashOutputs) */
+  hashOutputs: string
+  /** Set of authorized outpoints (txid.vout format) */
+  authorizedOutpoints: Set<string>
+  /** Timestamp when this authorization was created */
+  timestamp: number
+}

package/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "node",
+    "lib": [
+      "ES2022"
+    ],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "resolveJsonModule": true,
+    "allowSyntheticDefaultImports": true
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "ui"
+  ]
+}

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/basictokenmodule.ts","./src/index.ts","./src/types.ts"],"version":"5.9.3"}