snipe/web/node_modules/@exodus/bytes/wif.d.ts
pyr0ball 7a704441a6 feat(snipe): Vue 3 frontend scaffold + Docker web service
- web/: Vue 3 + Vite + UnoCSS + Pinia, dark tactical theme (amber/#0d1117)
- AppNav, ListingCard, SearchView with filters/sort, composables
  (useSnipeMode, useKonamiCode, useMotion), Pinia search store
- Steal shimmer, auction countdown, Snipe Mode easter egg all native in Vue
- docker/web/: nginx + multi-stage Dockerfile (node build → nginx serve)
- compose.yml: api (8510) + web (8509) services
- Dockerfile CMD updated to uvicorn for upcoming FastAPI layer
- Clean build: 0 TS errors, 380 modules
2026-03-25 15:11:35 -07:00

76 lines
2.2 KiB
TypeScript

/**
* Wallet Import Format (WIF) encoding and decoding.
*
* ```js
* import { fromWifString, toWifString } from '@exodus/bytes/wif.js'
* import { fromWifStringSync, toWifStringSync } from '@exodus/bytes/wif.js'
* ```
*
* On non-Node.js, requires peer dependency [@noble/hashes](https://www.npmjs.com/package/@noble/hashes) to be installed.
*
* @module @exodus/bytes/wif.js
*/
/// <reference types="node" />
import type { Uint8ArrayBuffer } from './array.js';
/**
* WIF (Wallet Import Format) data structure
*/
export interface Wif {
/** Network version byte */
version: number;
/** 32-byte private key */
privateKey: Uint8ArrayBuffer;
/** Whether the key is compressed */
compressed: boolean;
}
/**
* Decode a WIF string to WIF data
*
* Returns a promise that resolves to an object with `{ version, privateKey, compressed }`.
*
* The optional `version` parameter validates the version byte.
*
* Throws if the WIF string is invalid or version doesn't match.
*
* @param string - The WIF encoded string
* @param version - Optional expected version byte to validate against
* @returns The decoded WIF data
* @throws Error if the WIF string is invalid or version doesn't match
*/
export function fromWifString(string: string, version?: number): Promise<Wif>;
/**
* Decode a WIF string to WIF data (synchronous)
*
* Returns an object with `{ version, privateKey, compressed }`.
*
* The optional `version` parameter validates the version byte.
*
* Throws if the WIF string is invalid or version doesn't match.
*
* @param string - The WIF encoded string
* @param version - Optional expected version byte to validate against
* @returns The decoded WIF data
* @throws Error if the WIF string is invalid or version doesn't match
*/
export function fromWifStringSync(string: string, version?: number): Wif;
/**
* Encode WIF data to a WIF string
*
* @param wif - The WIF data to encode
* @returns The WIF encoded string
*/
export function toWifString(wif: Wif): Promise<string>;
/**
* Encode WIF data to a WIF string (synchronous)
*
* @param wif - The WIF data to encode
* @returns The WIF encoded string
*/
export function toWifStringSync(wif: Wif): string;