@fedimint/core 0.1.0

package/dist/dts/types/wallet.d.ts

@@ -0,0 +1,241 @@
+import { MSats, Duration, JSONValue, JSONObject } from './utils';
+declare const MODULE_KINDS: readonly ["", "ln", "mint", "wallet"];
+type ModuleKind = (typeof MODULE_KINDS)[number];
+type FederationConfig = JSONObject;
+type GatewayInfo = {
+    gateway_id: string;
+    api: string;
+    node_pub_key: string;
+    federation_index: number;
+    route_hints: RouteHint[];
+    fees: FeeToAmount;
+};
+type LightningGateway = {
+    info: GatewayInfo;
+    vetted: boolean;
+    ttl: Duration;
+};
+type RouteHint = {};
+type FeeToAmount = {};
+type OutgoingLightningPayment = {
+    payment_type: PayType;
+    contract_id: string;
+    fee: MSats;
+};
+type PayType = {
+    lightning: string;
+} | {
+    internal: string;
+};
+type LnPayState = 'created' | 'canceled' | {
+    funded: {
+        block_height: number;
+    };
+} | {
+    waiting_for_refund: {
+        error_reason: string;
+    };
+} | 'awaiting_change' | {
+    success: {
+        preimage: string;
+    };
+} | {
+    refunded: {
+        gateway_error: string;
+    };
+} | {
+    unexpected_error: {
+        error_message: string;
+    };
+};
+type LnReceiveState = 'created' | {
+    waiting_for_payment: {
+        invoice: string;
+        timeout: number;
+    };
+} | {
+    canceled: {
+        reason: string;
+    };
+} | 'funded' | 'awaiting_funds' | 'claimed';
+type LnInternalPayState = 'funding' | {
+    preimage: string;
+} | {
+    refund_success: {
+        out_points: BtcOutPoint[];
+        error: string;
+    };
+} | {
+    refund_error: {
+        error_message: string;
+        error: string;
+    };
+} | {
+    funding_failed: {
+        error: string;
+    };
+} | {
+    unexpected_error: string;
+};
+type CreateBolt11Response = {
+    operation_id: string;
+    invoice: string;
+};
+type StreamError = {
+    error: string;
+    data: never;
+    end: never;
+};
+type StreamSuccess<T extends JSONValue> = {
+    data: T;
+    error: never;
+    end: never;
+};
+type StreamEnd = {
+    end: string;
+    data: never;
+    error: never;
+};
+type StreamResult<T extends JSONValue> = StreamSuccess<T> | StreamError | StreamEnd;
+type CancelFunction = () => void;
+type ReissueExternalNotesState = 'Created' | 'Issuing' | 'Done';
+type MintSpendNotesResponse = Array<string>;
+type SpendNotesState = 'Created' | 'UserCanceledProcessing' | 'UserCanceledSuccess' | 'UserCanceledFailure' | 'Success' | 'Refunded';
+type TxOutputSummary = {
+    outpoint: {
+        txid: string;
+        vout: number;
+    };
+    amount: number;
+};
+type BtcOutPoint = {
+    txid: string;
+    vout: number;
+};
+type WalletDepositState = 'WaitingForTransaction' | {
+    WaitingForConfirmation: {
+        btc_deposited: number;
+        btc_out_point: BtcOutPoint;
+    };
+} | {
+    Confirmed: {
+        btc_deposited: number;
+        btc_out_point: BtcOutPoint;
+    };
+} | {
+    Claimed: {
+        btc_deposited: number;
+        btc_out_point: BtcOutPoint;
+    };
+} | {
+    Failed: string;
+};
+type WalletSummary = {
+    spendable_utxos: TxOutputSummary[];
+    unsigned_peg_out_txos: TxOutputSummary[];
+    unsigned_change_utxos: TxOutputSummary[];
+    unconfirmed_peg_out_txos: TxOutputSummary[];
+    unconfirmed_change_utxos: TxOutputSummary[];
+};
+type LnVariant = {
+    pay?: {
+        gateway_id: string;
+        invoice: string;
+        fee: number;
+        is_internal_payment: boolean;
+        out_point: {
+            out_idx: number;
+            txid: string;
+        };
+    };
+    receive?: {
+        gateway_id: string;
+        invoice: string;
+        out_point: {
+            out_idx: number;
+            txid: string;
+        };
+    };
+};
+type MintVariant = {
+    spend_o_o_b?: {
+        requested_amount: number;
+        oob_notes: string;
+    };
+    reissuance?: {
+        txid: string;
+    };
+};
+type WalletVariant = {
+    deposit?: {
+        address: string;
+        tweak_idx: number;
+    };
+    withdraw?: {
+        address: string;
+        amountMsats: number;
+        fee: {
+            fee_rate: {
+                sats_per_kvb: number;
+            };
+            total_weight: number;
+        };
+    };
+};
+type OperationKey = {
+    creation_time: {
+        nanos_since_epoch: number;
+        secs_since_epoch: number;
+    };
+    operation_id: string;
+};
+type OperationMeta = {
+    amount: number;
+    extra_meta: JSONObject;
+    variant: LnVariant | MintVariant | WalletVariant;
+};
+type OperationLog = {
+    meta: OperationMeta;
+    operation_module_kind: string;
+    outcome: {
+        outcome: LnPayState | LnReceiveState | SpendNotesState | WalletDepositState;
+    };
+};
+type BaseTransactions = {
+    timestamp: number;
+    operationId: string;
+    kind: 'ln' | 'mint' | 'wallet';
+};
+type LightningTransaction = BaseTransactions & {
+    type: 'send' | 'receive';
+    invoice: string;
+    outcome: 'created' | 'canceled' | 'claimed' | 'pending' | 'success' | 'funded' | 'awaiting_funds' | 'unexpected_error';
+    gateway: string;
+    fee?: number;
+    internalPay?: boolean;
+    preimage?: string;
+    txId: string;
+};
+type EcashTransaction = BaseTransactions & {
+    type: 'spend_oob' | 'reissue';
+    amountMsats: number;
+    outcome?: SpendNotesState | ReissueExternalNotesState;
+    notes?: string;
+    txId?: string;
+};
+type WalletTransaction = BaseTransactions & {
+    type: 'withdraw' | 'deposit';
+    onchainAddress: string;
+    amountMsats: number;
+    fee: number;
+    outcome?: 'WaitingForTransaction' | 'WaitingForConfirmation' | 'Confirmed' | 'Claimed' | 'Failed';
+};
+type Transactions = LightningTransaction | EcashTransaction | WalletTransaction;
+/** Keys are powers of 2 */
+type NoteCountByDenomination = Record<number, number>;
+type GenerateAddressResponse = {
+    deposit_address: string;
+    operation_id: string;
+};
+export { LightningGateway, FederationConfig, RouteHint, FeeToAmount, OutgoingLightningPayment, PayType, LnPayState, LnReceiveState, CreateBolt11Response, GatewayInfo, StreamError, StreamSuccess, StreamResult, ModuleKind, CancelFunction, LnInternalPayState, ReissueExternalNotesState, MintSpendNotesResponse, SpendNotesState, WalletSummary, TxOutputSummary, NoteCountByDenomination, GenerateAddressResponse, OperationKey, OperationLog, LnVariant, MintVariant, WalletVariant, LightningTransaction, EcashTransaction, WalletTransaction, Transactions, WalletDepositState, };
+//# sourceMappingURL=wallet.d.ts.map

package/dist/dts/types/wallet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"wallet.d.ts","sourceRoot":"","sources":["../../../src/types/wallet.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAA;AAEhE,QAAA,MAAM,YAAY,uCAAwC,CAAA;AAC1D,KAAK,UAAU,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AAG/C,KAAK,gBAAgB,GAAG,UAAU,CAAA;AAElC,KAAK,WAAW,GAAG;IACjB,UAAU,EAAE,MAAM,CAAA;IAClB,GAAG,EAAE,MAAM,CAAA;IACX,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;IACxB,WAAW,EAAE,SAAS,EAAE,CAAA;IACxB,IAAI,EAAE,WAAW,CAAA;CAClB,CAAA;AACD,KAAK,gBAAgB,GAAG;IACtB,IAAI,EAAE,WAAW,CAAA;IACjB,MAAM,EAAE,OAAO,CAAA;IACf,GAAG,EAAE,QAAQ,CAAA;CACd,CAAA;AAED,KAAK,SAAS,GAAG,EAEhB,CAAA;AAED,KAAK,WAAW,GAAG,EAElB,CAAA;AAED,KAAK,wBAAwB,GAAG;IAC9B,YAAY,EAAE,OAAO,CAAA;IACrB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,KAAK,CAAA;CACX,CAAA;AAED,KAAK,OAAO,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAA;AAE3D,KAAK,UAAU,GACX,SAAS,GACT,UAAU,GACV;IAAE,MAAM,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACpC;IAAE,kBAAkB,EAAE;QAAE,YAAY,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAChD,iBAAiB,GACjB;IAAE,OAAO,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACjC;IAAE,QAAQ,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACvC;IAAE,gBAAgB,EAAE;QAAE,aAAa,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAAA;AAEnD,KAAK,cAAc,GACf,SAAS,GACT;IAAE,mBAAmB,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAC7D;IAAE,QAAQ,EAAE;QAAE,MAAM,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAChC,QAAQ,GACR,gBAAgB,GAChB,SAAS,CAAA;AAEb,KAAK,kBAAkB,GACnB,SAAS,GACT;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GACpB;IAAE,cAAc,EAAE;QAAE,UAAU,EAAE,WAAW,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAChE;IAAE,YAAY,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GAC1D;IAAE,cAAc,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,GACrC;IAAE,gBAAgB,EAAE,MAAM,CAAA;CAAE,CAAA;AAEhC,KAAK,oBAAoB,GAAG;IAC1B,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,KAAK,CAAA;IACX,GAAG,EAAE,KAAK,CAAA;CACX,CAAA;AAED,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,IAAI;IACxC,IAAI,EAAE,CAAC,CAAA;IACP,KAAK,EAAE,KAAK,CAAA;IACZ,GAAG,EAAE,KAAK,CAAA;CACX,CAAA;AAED,KAAK,SAAS,GAAG;IACf,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,KAAK,CAAA;IACX,KAAK,EAAE,KAAK,CAAA;CACb,CAAA;AAED,KAAK,YAAY,CAAC,CAAC,SAAS,SAAS,IACjC,aAAa,CAAC,CAAC,CAAC,GAChB,WAAW,GACX,SAAS,CAAA;AAEb,KAAK,cAAc,GAAG,MAAM,IAAI,CAAA;AAEhC,KAAK,yBAAyB,GAAG,SAAS,GAAG,SAAS,GAAG,MAAM,CAAA;AAG/D,KAAK,sBAAsB,GAAG,KAAK,CAAC,MAAM,CAAC,CAAA;AAE3C,KAAK,eAAe,GAChB,SAAS,GACT,wBAAwB,GACxB,qBAAqB,GACrB,qBAAqB,GACrB,SAAS,GACT,UAAU,CAAA;AAEd,KAAK,eAAe,GAAG;IACrB,QAAQ,EAAE;QACR,IAAI,EAAE,MAAM,CAAA;QACZ,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;IACD,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,KAAK,kBAAkB,GACnB,uBAAuB,GACvB;IACE,sBAAsB,EAAE;QACtB,aAAa,EAAE,MAAM,CAAA;QACrB,aAAa,EAAE,WAAW,CAAA;KAC3B,CAAA;CACF,GACD;IAAE,SAAS,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,WAAW,CAAA;KAAE,CAAA;CAAE,GACpE;IAAE,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,aAAa,EAAE,WAAW,CAAA;KAAE,CAAA;CAAE,GAClE;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAEtB,KAAK,aAAa,GAAG;IACnB,eAAe,EAAE,eAAe,EAAE,CAAA;IAClC,qBAAqB,EAAE,eAAe,EAAE,CAAA;IACxC,qBAAqB,EAAE,eAAe,EAAE,CAAA;IAExC,wBAAwB,EAAE,eAAe,EAAE,CAAA;IAC3C,wBAAwB,EAAE,eAAe,EAAE,CAAA;CAC5C,CAAA;AAED,KAAK,SAAS,GAAG;IACf,GAAG,CAAC,EAAE;QACJ,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;QACf,GAAG,EAAE,MAAM,CAAA;QACX,mBAAmB,EAAE,OAAO,CAAA;QAC5B,SAAS,EAAE;YACT,OAAO,EAAE,MAAM,CAAA;YACf,IAAI,EAAE,MAAM,CAAA;SACb,CAAA;KACF,CAAA;IACD,OAAO,CAAC,EAAE;QACR,UAAU,EAAE,MAAM,CAAA;QAClB,OAAO,EAAE,MAAM,CAAA;QACf,SAAS,EAAE;YACT,OAAO,EAAE,MAAM,CAAA;YACf,IAAI,EAAE,MAAM,CAAA;SACb,CAAA;KACF,CAAA;CACF,CAAA;AAED,KAAK,WAAW,GAAG;IACjB,WAAW,CAAC,EAAE;QACZ,gBAAgB,EAAE,MAAM,CAAA;QACxB,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,UAAU,CAAC,EAAE;QACX,IAAI,EAAE,MAAM,CAAA;KACb,CAAA;CACF,CAAA;AAED,KAAK,aAAa,GAAG;IACnB,OAAO,CAAC,EAAE;QACR,OAAO,EAAE,MAAM,CAAA;QACf,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,QAAQ,CAAC,EAAE;QACT,OAAO,EAAE,MAAM,CAAA;QACf,WAAW,EAAE,MAAM,CAAA;QACnB,GAAG,EAAE;YACH,QAAQ,EAAE;gBACR,YAAY,EAAE,MAAM,CAAA;aACrB,CAAA;YACD,YAAY,EAAE,MAAM,CAAA;SACrB,CAAA;KACF,CAAA;CACF,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,aAAa,EAAE;QAAE,iBAAiB,EAAE,MAAM,CAAC;QAAC,gBAAgB,EAAE,MAAM,CAAA;KAAE,CAAA;IACtE,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AACD,KAAK,aAAa,GAAG;IACnB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,UAAU,CAAA;IACtB,OAAO,EAAE,SAAS,GAAG,WAAW,GAAG,aAAa,CAAA;CACjD,CAAA;AAED,KAAK,YAAY,GAAG;IAClB,IAAI,EAAE,aAAa,CAAA;IACnB,qBAAqB,EAAE,MAAM,CAAA;IAC7B,OAAO,EAAE;QACP,OAAO,EAAE,UAAU,GAAG,cAAc,GAAG,eAAe,GAAG,kBAAkB,CAAA;KAC5E,CAAA;CACF,CAAA;AAED,KAAK,gBAAgB,GAAG;IACtB,SAAS,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,QAAQ,CAAA;CAC/B,CAAA;AAED,KAAK,oBAAoB,GAAG,gBAAgB,GAAG;IAC7C,IAAI,EAAE,MAAM,GAAG,SAAS,CAAA;IACxB,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EACH,SAAS,GACT,UAAU,GACV,SAAS,GACT,SAAS,GACT,SAAS,GACT,QAAQ,GACR,gBAAgB,GAChB,kBAAkB,CAAA;IACtB,OAAO,EAAE,MAAM,CAAA;IACf,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,KAAK,gBAAgB,GAAG,gBAAgB,GAAG;IACzC,IAAI,EAAE,WAAW,GAAG,SAAS,CAAA;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,eAAe,GAAG,yBAAyB,CAAA;IACrD,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,KAAK,iBAAiB,GAAG,gBAAgB,GAAG;IAC1C,IAAI,EAAE,UAAU,GAAG,SAAS,CAAA;IAC5B,cAAc,EAAE,MAAM,CAAA;IACtB,WAAW,EAAE,MAAM,CAAA;IACnB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,CAAC,EACJ,uBAAuB,GACvB,wBAAwB,GACxB,WAAW,GACX,SAAS,GACT,QAAQ,CAAA;CACb,CAAA;AAED,KAAK,YAAY,GAAG,oBAAoB,GAAG,gBAAgB,GAAG,iBAAiB,CAAA;AAE/E,2BAA2B;AAC3B,KAAK,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;AAErD,KAAK,uBAAuB,GAAG;IAC7B,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,OAAO,EACL,gBAAgB,EAChB,gBAAgB,EAChB,SAAS,EACT,WAAW,EACX,wBAAwB,EACxB,OAAO,EACP,UAAU,EACV,cAAc,EACd,oBAAoB,EACpB,WAAW,EACX,WAAW,EACX,aAAa,EACb,YAAY,EACZ,UAAU,EACV,cAAc,EACd,kBAAkB,EAClB,yBAAyB,EACzB,sBAAsB,EACtB,eAAe,EACf,aAAa,EACb,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,YAAY,EACZ,YAAY,EACZ,SAAS,EACT,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,EACZ,kBAAkB,GACnB,CAAA"}

package/dist/dts/utils/logger.d.ts

@@ -0,0 +1,24 @@
+import type { TransportLogger } from '@fedimint/types';
+declare const logLevels: readonly ["debug", "info", "warn", "error", "none"];
+export type LogLevel = (typeof logLevels)[number];
+export declare class Logger {
+    private level;
+    private logger;
+    /**
+     * Generic Logger for a given environment.
+     *
+     * @param _logger - The transport's logger to use. (console for web, react native, etc.)
+     * @param level - The log level to use. (debug, info, warn, error, none)
+     */
+    constructor(_logger?: TransportLogger, level?: LogLevel);
+    setLevel(level: LogLevel): void;
+    private coerceLevel;
+    log(level: string, message: string, ...args: any[]): void;
+    debug(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+    private shouldLog;
+}
+export {};
+//# sourceMappingURL=logger.d.ts.map

package/dist/dts/utils/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../../src/utils/logger.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAEtD,QAAA,MAAM,SAAS,qDAAsD,CAAA;AACrE,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAA;AAEjD,qBAAa,MAAM;IACjB,OAAO,CAAC,KAAK,CAAU;IACvB,OAAO,CAAC,MAAM,CAAiB;IAE/B;;;;;OAKG;gBACS,OAAO,GAAE,eAAyB,EAAE,KAAK,GAAE,QAAiB;IAKxE,QAAQ,CAAC,KAAK,EAAE,QAAQ;IAIxB,OAAO,CAAC,WAAW;IAOnB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IASlD,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAIrC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAIpC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAIpC,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE;IAIrC,OAAO,CAAC,SAAS;CAYlB"}