@gvnrdao/dh-sdk 0.0.286 → 0.0.288

package/dist/types/authorization-params.d.ts

@@ -1,160 +0,0 @@
-/**
- * Typed Authorization Parameters using Discriminated Unions
- *
- * This file defines type-safe authorization parameter types that replace
- * the generic `Record<string, any>` previously used in AuthorizationRequest.
- *
- * Each authorization action has its own specific parameter type, ensuring
- * compile-time safety and better IDE support.
- */
-import { UCD, Satoshis, UnixTimestamp } from "./branded/domain-values";
-/**
- * Base authorization parameters shared by all authorization types
- */
-interface BaseAuthParams {
-    /** Unix timestamp when the authorization request was created */
-    timestamp: UnixTimestamp;
-    /** Chain ID where the operation will be executed */
-    chainId: number;
-}
-/**
- * Parameters for creating a new loan/position
- */
-export interface CreateLoanAuthParams extends BaseAuthParams {
-    type: "create";
-    /** Selected loan term in months (e.g., 12, 24, 36) */
-    selectedTerm: number;
-    /** Borrower's Ethereum address */
-    borrower: string;
-    /** PKP public key for Bitcoin custody */
-    publicKey: string;
-}
-/**
- * Parameters for minting UCD against existing collateral
- */
-export interface MintUCDAuthParams extends BaseAuthParams {
-    type: "mint";
-    /** Position/loan identifier */
-    positionId: string;
-    /** Amount of UCD to mint (in wei, 18 decimals) */
-    amount: UCD;
-    /** PKP public key (optional - validator PKP is passed separately to authorizeMintUCD) */
-    publicKey?: string;
-    /** Bitcoin provider URL for balance verification */
-    bitcoinProviderUrl?: string;
-    /** Selected term in months (override when contract state is zero) */
-    selectedTerm?: number;
-}
-/**
- * Parameters for withdrawing Bitcoin from vault
- */
-export interface WithdrawBTCAuthParams extends BaseAuthParams {
-    type: "withdraw";
-    /** Position/loan identifier */
-    positionId: string;
-    /** Destination Bitcoin address */
-    destinationAddress: string;
-    /** Amount to withdraw in satoshis */
-    amount: Satoshis;
-    /** PKP public key */
-    publicKey: string;
-}
-/**
- * Parameters for repaying UCD debt
- */
-export interface RepayDebtAuthParams extends BaseAuthParams {
-    type: "repay";
-    /** Position/loan identifier */
-    positionId: string;
-    /** Amount of UCD to repay (in wei, 18 decimals) */
-    amount: UCD;
-    /** Whether this is a full repayment closing the position */
-    closeLoan: boolean;
-}
-/**
- * Parameters for extending loan term
- */
-export interface ExtendTermAuthParams extends BaseAuthParams {
-    type: "extend";
-    /** Position/loan identifier */
-    positionId: string;
-    /** New term length in months */
-    newTerm: number;
-    /** Expected extension fee in UCD */
-    extensionFee: UCD;
-}
-/**
- * Parameters for closing a position
- */
-export interface ClosePositionAuthParams extends BaseAuthParams {
-    type: "close";
-    /** Position/loan identifier */
-    positionId: string;
-    /** Final debt amount being repaid */
-    finalDebt: UCD;
-}
-/**
- * Union type of all possible authorization parameters
- *
- * This is a discriminated union keyed by the 'type' field.
- * TypeScript can narrow the type based on the 'type' value.
- *
- * @example
- * ```typescript
- * function handleAuth(params: AuthorizationParams) {
- *   switch (params.type) {
- *     case 'mint':
- *       // TypeScript knows params has positionId, amount, publicKey
- *       return handleMint(params.positionId, params.amount);
- *     case 'withdraw':
- *       // TypeScript knows params has destinationAddress
- *       return handleWithdraw(params.destinationAddress, params.amount);
- *   }
- * }
- * ```
- */
-export type AuthorizationParams = CreateLoanAuthParams | MintUCDAuthParams | WithdrawBTCAuthParams | RepayDebtAuthParams | ExtendTermAuthParams | ClosePositionAuthParams;
-/**
- * Type guard to check if params are for loan creation
- */
-export declare function isCreateLoanAuth(params: AuthorizationParams): params is CreateLoanAuthParams;
-/**
- * Type guard to check if params are for UCD minting
- */
-export declare function isMintUCDAuth(params: AuthorizationParams): params is MintUCDAuthParams;
-/**
- * Type guard to check if params are for BTC withdrawal
- */
-export declare function isWithdrawBTCAuth(params: AuthorizationParams): params is WithdrawBTCAuthParams;
-/**
- * Type guard to check if params are for debt repayment
- */
-export declare function isRepayDebtAuth(params: AuthorizationParams): params is RepayDebtAuthParams;
-/**
- * Type guard to check if params are for term extension
- */
-export declare function isExtendTermAuth(params: AuthorizationParams): params is ExtendTermAuthParams;
-/**
- * Type guard to check if params are for position closure
- */
-export declare function isClosePositionAuth(params: AuthorizationParams): params is ClosePositionAuthParams;
-/**
- * Helper to extract the action type from authorization params
- */
-export declare function getAuthActionType(params: AuthorizationParams): string;
-/**
- * Validation helpers for authorization parameters
- */
-export declare namespace AuthParamsValidation {
-    function validateCreateLoan(params: CreateLoanAuthParams): string[];
-    function validateMintUCD(params: MintUCDAuthParams): string[];
-    function validateWithdrawBTC(params: WithdrawBTCAuthParams): string[];
-    function validateRepayDebt(params: RepayDebtAuthParams): string[];
-    function validateExtendTerm(params: ExtendTermAuthParams): string[];
-    function validateClosePosition(params: ClosePositionAuthParams): string[];
-    /**
-     * Validates authorization params based on their type
-     */
-    function validate(params: AuthorizationParams): string[];
-}
-export {};

package/dist/types/branded/domain-values.d.ts

@@ -1,138 +0,0 @@
-/**
- * Branded types for domain-specific values to prevent mixing incompatible units
- *
- * These types provide compile-time safety to ensure we don't accidentally
- * use Bitcoin satoshis where UCD is expected, or vice versa.
- *
- * @example
- * ```typescript
- * const debt: UCD = UCD(1000000n);
- * const balance: Satoshis = Satoshis(50000000n);
- *
- * // This will cause a TypeScript error:
- * await mintUCD(balance); // Error: Cannot use Satoshis where UCD expected
- * ```
- */
-declare const __brand: unique symbol;
-/**
- * UCD (USD Coin Diamond) - The stablecoin minted against Bitcoin collateral
- * Base unit: 1 UCD = 10^18 wei (matches ERC20 decimals)
- */
-export type UCD = bigint & {
-    readonly [__brand]: 'UCD';
-};
-/**
- * Satoshis - Bitcoin base unit
- * Base unit: 1 BTC = 100,000,000 satoshis
- */
-export type Satoshis = bigint & {
-    readonly [__brand]: 'Satoshis';
-};
-/**
- * Wei - Ethereum base unit for ETH and ERC20 tokens (18 decimals)
- * Base unit: 1 token = 10^18 wei
- */
-export type Wei = bigint & {
-    readonly [__brand]: 'Wei';
-};
-/**
- * BPS - Basis Points for percentage calculations
- * Base unit: 1% = 100 BPS, 100% = 10,000 BPS
- */
-export type BPS = number & {
-    readonly [__brand]: 'BPS';
-};
-/**
- * UnixTimestamp - Unix timestamp in seconds
- */
-export type UnixTimestamp = number & {
-    readonly [__brand]: 'UnixTimestamp';
-};
-/**
- * BlockNumber - Ethereum block number
- */
-export type BlockNumber = number & {
-    readonly [__brand]: 'BlockNumber';
-};
-export declare const UCD: (value: bigint) => UCD;
-export declare const Satoshis: (value: bigint) => Satoshis;
-export declare const Wei: (value: bigint) => Wei;
-export declare const BPS: (value: number) => BPS;
-export declare const UnixTimestamp: (value: number) => UnixTimestamp;
-export declare const BlockNumber: (value: number) => BlockNumber;
-export declare function isUCD(value: unknown): value is UCD;
-export declare function isSatoshis(value: unknown): value is Satoshis;
-export declare function isWei(value: unknown): value is Wei;
-export declare function isBPS(value: unknown): value is BPS;
-export declare function isUnixTimestamp(value: unknown): value is UnixTimestamp;
-export declare function isBlockNumber(value: unknown): value is BlockNumber;
-export declare namespace UCDConversions {
-    function fromWhole(whole: number | string): UCD;
-    function toWhole(ucd: UCD): number;
-    function format(ucd: UCD, decimals?: number): string;
-    /**
-     * Convert UCD to JSON-serializable string
-     */
-    function toJSON(ucd: UCD): string;
-    /**
-     * Parse UCD from JSON string
-     */
-    function fromJSON(json: string): UCD;
-    /**
-     * Convert to structured serializable format with metadata
-     */
-    function toSerializable(ucd: UCD): {
-        value: string;
-        decimals: number;
-        type: 'UCD';
-    };
-}
-export declare namespace SatoshisConversions {
-    function fromBTC(btc: number | string): Satoshis;
-    function toBTC(satoshis: Satoshis): number;
-    function format(satoshis: Satoshis, unit?: 'BTC' | 'sats'): string;
-    /**
-     * Convert Satoshis to JSON-serializable string
-     */
-    function toJSON(satoshis: Satoshis): string;
-    /**
-     * Parse Satoshis from JSON string
-     */
-    function fromJSON(json: string): Satoshis;
-    /**
-     * Convert to structured serializable format with metadata
-     */
-    function toSerializable(satoshis: Satoshis): {
-        value: string;
-        unit: 'satoshis';
-        type: 'Satoshis';
-    };
-}
-export declare namespace WeiConversions {
-    function fromWhole(whole: number | string): Wei;
-    function toWhole(wei: Wei): number;
-    function format(wei: Wei, decimals?: number): string;
-    /**
-     * Convert Wei to JSON-serializable string
-     */
-    function toJSON(wei: Wei): string;
-    /**
-     * Parse Wei from JSON string
-     */
-    function fromJSON(json: string): Wei;
-    /**
-     * Convert to structured serializable format with metadata
-     */
-    function toSerializable(wei: Wei): {
-        value: string;
-        decimals: number;
-        type: 'Wei';
-    };
-}
-export declare namespace BPSConversions {
-    function fromPercent(percent: number): BPS;
-    function toPercent(bps: BPS): number;
-    function toDecimal(bps: BPS): number;
-    function format(bps: BPS): string;
-}
-export {};

package/dist/types/branded/ids.d.ts

@@ -1,23 +0,0 @@
-/**
- * Branded identifier types for PKP and Position IDs.
- *
- * These provide lightweight nominal typing so that internal helpers can
- * distinguish between generic strings and protocol identifiers, while
- * still being freely assignable to `string` where needed.
- */
-declare const __idBrand: unique symbol;
-/**
- * PKP token identifier (decimal string or hex string, depending on context).
- */
-export type PkpId = string & {
-    readonly [__idBrand]: "PkpId";
-};
-/**
- * Position identifier (on-chain bytes32, represented as hex string in SDK).
- */
-export type PositionId = string & {
-    readonly [__idBrand]: "PositionId";
-};
-export declare const PkpId: (value: string) => PkpId;
-export declare const PositionId: (value: string) => PositionId;
-export {};

package/dist/types/event-types.d.ts

@@ -1,261 +0,0 @@
-/**
- * Loan Event Types
- *
- * Type definitions for all loan-related events tracked by the Diamond Hands Protocol.
- * These events are indexed by The Graph subgraph and can be queried via the SDK.
- */
-export declare enum PaymentType {
-    FULL_REPAYMENT = "FULL_REPAYMENT",
-    PARTIAL_PAYMENT = "PARTIAL_PAYMENT",
-    EXTENSION_FEE = "EXTENSION_FEE"
-}
-export declare enum PositionStatus {
-    PENDING_DEPOSIT = "PENDING_DEPOSIT",
-    PENDING_MINT = "PENDING_MINT",
-    ACTIVE = "ACTIVE",
-    EXPIRED = "EXPIRED",
-    LIQUIDATABLE = "LIQUIDATABLE",
-    LIQUIDATED = "LIQUIDATED",
-    REPAID = "REPAID",
-    CLOSED = "CLOSED"
-}
-export interface PositionCreatedEvent {
-    id: string;
-    positionId: string;
-    pkpId: string;
-    borrower: string;
-    requestedCollateralRatio: string;
-    selectedTerm: string;
-    expiryAt: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-}
-export interface PaymentEvent {
-    id: string;
-    positionId: string;
-    payer: string;
-    amount: string;
-    type: PaymentType;
-    transactionHash: string;
-    timestamp: string;
-    blockNumber: string;
-    logIndex: string;
-    newDebt: string;
-    newCollateralRatio: string;
-}
-export interface StatusUpdateEvent {
-    id: string;
-    positionId: string;
-    oldStatus: PositionStatus;
-    newStatus: PositionStatus;
-    reason?: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-}
-export interface LiquidationEvent {
-    id: string;
-    positionId: string;
-    liquidator: string;
-    liquidatedAmount: string;
-    collateralSeized: string;
-    transactionHash: string;
-    timestamp: string;
-    blockNumber: string;
-    commitHash?: string;
-    commitTimestamp?: string;
-    revealDelay?: string;
-}
-export interface UCDMintEvent {
-    id: string;
-    positionId: string;
-    amount: string;
-    proof: string;
-    minter: string;
-    isCommunityMint: boolean;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-}
-export interface WithdrawalEvent {
-    id: string;
-    positionId: string;
-    withdrawalAmount: string;
-    withdrawalAddress: string;
-    networkFee?: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-export interface RenewalEvent {
-    id: string;
-    positionId: string;
-    extensionTerm: string;
-    extensionFee: string;
-    newExpiryDate: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-export interface OperationFailureEvent {
-    id: string;
-    positionId: string;
-    operationType: string;
-    reason: string;
-    errorCode?: string;
-    amount?: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-export interface MintRequestEvent {
-    id: string;
-    positionId: string;
-    pkpId: string;
-    borrower: string;
-    mintAmount: string;
-    originationFee: string;
-    newDebt: string;
-    newCollateralRatio: string;
-    btcPrice: string;
-    quantumTimestamp: string;
-    opId: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-export interface BurnRequestEvent {
-    id: string;
-    positionId: string;
-    pkpId: string;
-    borrower: string;
-    burnAmount: string;
-    remainingDebt: string;
-    newCollateralRatio: string;
-    opId: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-/** Origination fee charged when UCD is minted via LIT Action (mintFee > 0). */
-export interface MintingFeeEvent {
-    id: string;
-    positionId: string;
-    borrower: string;
-    feeAmount: string;
-    mintAmount: string;
-    newDebt: string;
-    btcPrice: string;
-    quantumTimestamp: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-/** Extension fee charged when a position term is renewed (extensionFee > 0). */
-export interface RenewalFeeEvent {
-    id: string;
-    positionId: string;
-    borrower: string;
-    feeAmount: string;
-    extensionTerm: string;
-    newExpiryDate: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-/** Position-level collateral manager outcomes (POSITION_CLOSED, NETWORK_FEE_DEDUCTED) */
-export interface CollateralContractEvent {
-    id: string;
-    positionId: string;
-    eventType: string;
-    networkFee?: string;
-    remainingCollateral?: string;
-    collateralRatio?: string;
-    timestamp: string;
-    blockNumber: string;
-    transactionHash: string;
-    logIndex: string;
-}
-/**
- * Aggregate container for all position-scoped loan events.
- * Protocol-global admin events (circuit breaker, term fees, price bounds, etc.)
- * are available via sdk.getAllEvents({ kinds: ['admin'] }).
- */
-export interface LoanEvents {
-    positionId: string;
-    positionCreated?: PositionCreatedEvent;
-    payments: PaymentEvent[];
-    statusUpdates: StatusUpdateEvent[];
-    liquidation?: LiquidationEvent;
-    mints: UCDMintEvent[];
-    withdrawals: WithdrawalEvent[];
-    renewals: RenewalEvent[];
-    operationFailures: OperationFailureEvent[];
-    mintRequests: MintRequestEvent[];
-    burnRequests: BurnRequestEvent[];
-    collateralEvents: CollateralContractEvent[];
-    /** Origination fees charged on UCD mints. Populated when the subgraph indexes MintingFeeEvent. */
-    mintingFees: MintingFeeEvent[];
-    /** Extension fees charged on position renewals. Populated when the subgraph indexes RenewalFeeEvent. */
-    renewalFees: RenewalFeeEvent[];
-    totalEvents: number;
-}
-export interface LoanEventsFilter {
-    eventTypes?: Array<'positionCreated' | 'payment' | 'status' | 'liquidation' | 'mint' | 'withdrawal' | 'renewal' | 'operationFailure' | 'mintRequest' | 'burnRequest' | 'collateralEvent' | 'mintingFee' | 'renewalFee'>;
-    fromTimestamp?: string;
-    toTimestamp?: string;
-    fromBlock?: string;
-    toBlock?: string;
-    limit?: number;
-    orderDirection?: 'asc' | 'desc';
-}
-export declare function isValidPositionStatus(status: string): status is PositionStatus;
-export declare function isValidPaymentType(type: string): type is PaymentType;
-export declare function numericToPositionStatus(status: number): PositionStatus;
-export declare const EventHelpers: {
-    sortByTimestamp<T extends {
-        timestamp: string;
-    }>(events: T[], direction?: "asc" | "desc"): T[];
-    filterByTimestamp<T extends {
-        timestamp: string;
-    }>(events: T[], fromTimestamp?: string, toTimestamp?: string): T[];
-    filterByBlock<T extends {
-        blockNumber: string;
-    }>(events: T[], fromBlock?: string, toBlock?: string): T[];
-    getTotalCount(events: LoanEvents): number;
-    getAllEventsSorted(events: LoanEvents, direction?: "asc" | "desc"): Array<(PositionCreatedEvent & {
-        eventType: "positionCreated";
-    }) | (PaymentEvent & {
-        eventType: "payment";
-    }) | (StatusUpdateEvent & {
-        eventType: "status";
-    }) | (LiquidationEvent & {
-        eventType: "liquidation";
-    }) | (UCDMintEvent & {
-        eventType: "mint";
-    }) | (WithdrawalEvent & {
-        eventType: "withdrawal";
-    }) | (RenewalEvent & {
-        eventType: "renewal";
-    }) | (OperationFailureEvent & {
-        eventType: "operationFailure";
-    }) | (MintRequestEvent & {
-        eventType: "mintRequest";
-    }) | (BurnRequestEvent & {
-        eventType: "burnRequest";
-    }) | (CollateralContractEvent & {
-        eventType: "collateralEvent";
-    }) | (MintingFeeEvent & {
-        eventType: "mintingFee";
-    }) | (RenewalFeeEvent & {
-        eventType: "renewalFee";
-    })>;
-};