@argonprotocol/mainchain 1.3.18 → 1.3.19

package/lib/index.d.cts

@@ -11575,7 +11575,7 @@ declare class Vault {
      */
     activatedSecuritizationPerSlot(): bigint;
     calculateBitcoinFee(amount: bigint): bigint;
-    static get(client: ArgonClient, vaultId: number, tickDurationMillis?: number): Promise<Vault>;
+    static get(client: ArgonClient | ApiDecoration<'promise'>, vaultId: number, tickDurationMillis?: number): Promise<Vault>;
     static create(client: ArgonClient, keypair: KeyringPair, args: {
         securitization: bigint | number;
         securitizationRatio: number;
@@ -11610,60 +11610,112 @@ declare class PriceIndex {
     argonUsdTargetPrice?: BigNumber;
     argonTimeWeightedAverageLiquidity?: BigNumber;
     lastUpdatedTick?: number;
-    load(client: ArgonClient): Promise<this>;
+    load(client: ArgonClient | ApiDecoration<'promise'>): Promise<this>;
     getBtcMicrogonPrice(satoshis: bigint | number): bigint;
     get rValue(): BigNumber;
     get argonCpi(): BigNumber;
 }
 
 declare const SATS_PER_BTC = 100000000n;
-declare class BitcoinLocks {
-    readonly client: ArgonClient;
-    constructor(client: ArgonClient);
-    getUtxoIdFromEvents(events: GenericEvent$1[]): Promise<number | undefined>;
-    getMarketRate(priceIndex: PriceIndex, satoshis: number | bigint): Promise<bigint>;
-    getRedemptionRate(priceIndex: PriceIndex, details: {
-        satoshis: bigint;
-        peggedPrice?: bigint;
-    }): Promise<bigint>;
-    getMarketRateApi(satoshis: bigint): Promise<bigint>;
-    getRedemptionRateApi(satoshis: bigint): Promise<bigint>;
-    getConfig(): Promise<IBitcoinLockConfig>;
-    getBitcoinConfirmedBlockHeight(): Promise<number>;
+type IQueryableClient = ArgonClient | ApiDecoration<'promise'>;
+declare class BitcoinLock implements IBitcoinLock {
+    utxoId: number;
+    p2wshScriptHashHex: string;
+    vaultId: number;
+    peggedPrice: bigint;
+    liquidityPromised: bigint;
+    ownerAccount: string;
+    satoshis: bigint;
+    vaultPubkey: string;
+    securityFees: bigint;
+    vaultClaimPubkey: string;
+    ownerPubkey: string;
+    vaultXpubSources: {
+        parentFingerprint: Uint8Array;
+        cosignHdIndex: number;
+        claimHdIndex: number;
+    };
+    vaultClaimHeight: number;
+    openClaimHeight: number;
+    createdAtHeight: number;
+    isVerified: boolean;
+    isRejectedNeedsRelease: boolean;
+    fundHoldExtensionsByBitcoinExpirationHeight: Record<number, bigint>;
+    constructor(data: IBitcoinLock);
     /**
      * Gets the UTXO reference by ID.
-     * @param utxoId - The UTXO ID to look up.
-     * @param clientAtHeight - Optional client at the block height to query the UTXO reference at a specific point in time.
+     * @param client - client at the block height to query the UTXO reference at a specific point in time.
      * @return An object containing the transaction ID and output index, or undefined if not found.
      * @return.txid - The Bitcoin transaction ID of the UTXO.
      * @return.vout - The output index of the UTXO in the transaction.
      * @return.bitcoinTxid - The Bitcoin transaction ID of the UTXO formatted in little endian
      */
-    getUtxoRef(utxoId: number, clientAtHeight?: ApiDecoration<'promise'>): Promise<{
+    getUtxoRef(client: IQueryableClient): Promise<{
         txid: string;
         vout: number;
         bitcoinTxid: string;
     } | undefined>;
-    getReleaseRequest(utxoId: number, clientAtHeight?: ApiDecoration<'promise'>): Promise<IReleaseRequestDetails | undefined>;
-    submitVaultSignature(args: {
-        utxoId: number;
-        vaultSignature: Uint8Array;
+    findPendingMints(client: IQueryableClient): Promise<bigint[]>;
+    getRatchetPrice(client: IQueryableClient, priceIndex: PriceIndex, vault: Vault): Promise<{
+        burnAmount: bigint;
+        ratchetingFee: bigint;
+        marketRate: bigint;
+    }>;
+    ratchet(args: {
+        client: ArgonClient;
+        priceIndex: PriceIndex;
+        argonKeyring: KeyringPair;
+        vault: Vault;
+    } & ISubmittableOptions): Promise<{
+        txResult: TxResult;
+        getRatchetResult: () => Promise<{
+            securityFee: bigint;
+            txFee: bigint;
+            newPeggedPrice: bigint;
+            liquidityPromised: bigint;
+            pendingMint: bigint;
+            burned: bigint;
+            blockHeight: number;
+            bitcoinBlockHeight: number;
+        }>;
+    }>;
+    releasePrice(priceIndex: PriceIndex): Promise<bigint>;
+    requestRelease(args: {
+        client: ArgonClient;
+        priceIndex: PriceIndex;
+        releaseRequest: IReleaseRequest;
         argonKeyring: KeyringPair;
     } & ISubmittableOptions): Promise<TxResult>;
-    getBitcoinLock(utxoId: number): Promise<IBitcoinLock | undefined>;
+    getReleaseRequest(client: IQueryableClient): Promise<IReleaseRequestDetails | undefined>;
     /**
      * Finds the cosign signature for a vault lock by UTXO ID. Optionally waits for the signature
-     * @param utxoId - The UTXO ID of the bitcoin lock
+     * @param client - The Argon client with rpc access
+     * @param finalizedStateOnly - If true, only checks finalized state
      * @param waitForSignatureMillis - Optional timeout in milliseconds to wait for the signature. If -1, waits indefinitely.
      */
-    findVaultCosignSignature(utxoId: number, waitForSignatureMillis?: number): Promise<{
+    findVaultCosignSignature(client: ArgonClient, finalizedStateOnly?: boolean, waitForSignatureMillis?: number): Promise<{
         blockHeight: number;
         signature: Uint8Array;
     } | undefined>;
-    blockHashAtHeight(atHeight: number): Promise<string | undefined>;
-    getVaultCosignSignature(utxoId: number, atHeight: number): Promise<Uint8Array | undefined>;
-    findPendingMints(utxoId: number): Promise<bigint[]>;
-    createInitializeLockTx(args: {
+    getVaultCosignSignature(client: ArgonClient, atHeight: number): Promise<Uint8Array | undefined>;
+    static getUtxoIdFromEvents(client: IQueryableClient, events: GenericEvent$1[]): Promise<number | undefined>;
+    static getMarketRate(priceIndex: PriceIndex, satoshis: number | bigint): Promise<bigint>;
+    static getRedemptionRate(priceIndex: PriceIndex, details: {
+        satoshis: bigint;
+        peggedPrice?: bigint;
+    }): Promise<bigint>;
+    static getConfig(client: IQueryableClient): Promise<IBitcoinLockConfig>;
+    static getBitcoinConfirmedBlockHeight(client: IQueryableClient): Promise<number>;
+    static submitVaultSignature(args: {
+        client: ArgonClient;
+        utxoId: number;
+        vaultSignature: Uint8Array;
+        argonKeyring: KeyringPair;
+    } & ISubmittableOptions): Promise<TxResult>;
+    static get(client: IQueryableClient, utxoId: number): Promise<BitcoinLock | undefined>;
+    static blockHashAtHeight(client: ArgonClient, atHeight: number): Promise<string | undefined>;
+    static createInitializeTx(args: {
+        client: ArgonClient;
         vault: Vault;
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
@@ -11679,12 +11731,8 @@ declare class BitcoinLocks {
         availableBalance: bigint;
         txFeePlusTip: bigint;
     }>;
-    getBitcoinLockFromTxResult(txResult: TxResult): Promise<{
-        lock: IBitcoinLock;
-        createdAtHeight: number;
-        txResult: TxResult;
-    }>;
-    initializeLock(args: {
+    static initialize(args: {
+        client: ArgonClient;
         vault: Vault;
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
@@ -11692,46 +11740,18 @@ declare class BitcoinLocks {
         satoshis: bigint;
     } & ISubmittableOptions): Promise<{
         getLock(): Promise<{
-            lock: IBitcoinLock;
+            lock: BitcoinLock;
             createdAtHeight: number;
         }>;
         txResult: TxResult;
         securityFee: bigint;
     }>;
-    requiredSatoshisForArgonLiquidity(priceIndex: PriceIndex, argonAmount: bigint): Promise<bigint>;
-    requestRelease(args: {
-        lock: IBitcoinLock;
-        priceIndex: PriceIndex;
-        releaseRequest: IReleaseRequest;
-        argonKeyring: KeyringPair;
-    } & ISubmittableOptions): Promise<TxResult>;
-    releasePrice(priceIndex: PriceIndex, lock: {
-        satoshis: bigint;
-        peggedPrice: bigint;
-    }): Promise<bigint>;
-    getRatchetPrice(lock: IBitcoinLock, priceIndex: PriceIndex, vault: Vault): Promise<{
-        burnAmount: bigint;
-        ratchetingFee: bigint;
-        marketRate: bigint;
-    }>;
-    ratchet(args: {
-        lock: IBitcoinLock;
-        priceIndex: PriceIndex;
-        argonKeyring: KeyringPair;
-        vault: Vault;
-    } & ISubmittableOptions): Promise<{
+    static getBitcoinLockFromTxResult(client: IQueryableClient, txResult: TxResult): Promise<{
+        lock: BitcoinLock;
+        createdAtHeight: number;
         txResult: TxResult;
-        getRatchetResult: () => Promise<{
-            securityFee: bigint;
-            txFee: bigint;
-            newPeggedPrice: bigint;
-            liquidityPromised: bigint;
-            pendingMint: bigint;
-            burned: bigint;
-            blockHeight: number;
-            bitcoinBlockHeight: number;
-        }>;
     }>;
+    static requiredSatoshisForArgonLiquidity(priceIndex: PriceIndex, argonAmount: bigint): Promise<bigint>;
 }
 interface IBitcoinLockConfig {
     lockReleaseCosignDeadlineFrames: number;
@@ -11786,4 +11806,4 @@ declare function waitForLoad(): Promise<void>;
  */
 declare function getClient(host: string, options?: ApiOptions): Promise<ArgonClient>;
 
-export { type ArgonClient, BitcoinLocks, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };
+export { type ArgonClient, BitcoinLock, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };

package/lib/index.d.ts

@@ -11575,7 +11575,7 @@ declare class Vault {
      */
     activatedSecuritizationPerSlot(): bigint;
     calculateBitcoinFee(amount: bigint): bigint;
-    static get(client: ArgonClient, vaultId: number, tickDurationMillis?: number): Promise<Vault>;
+    static get(client: ArgonClient | ApiDecoration<'promise'>, vaultId: number, tickDurationMillis?: number): Promise<Vault>;
     static create(client: ArgonClient, keypair: KeyringPair, args: {
         securitization: bigint | number;
         securitizationRatio: number;
@@ -11610,60 +11610,112 @@ declare class PriceIndex {
     argonUsdTargetPrice?: BigNumber;
     argonTimeWeightedAverageLiquidity?: BigNumber;
     lastUpdatedTick?: number;
-    load(client: ArgonClient): Promise<this>;
+    load(client: ArgonClient | ApiDecoration<'promise'>): Promise<this>;
     getBtcMicrogonPrice(satoshis: bigint | number): bigint;
     get rValue(): BigNumber;
     get argonCpi(): BigNumber;
 }
 
 declare const SATS_PER_BTC = 100000000n;
-declare class BitcoinLocks {
-    readonly client: ArgonClient;
-    constructor(client: ArgonClient);
-    getUtxoIdFromEvents(events: GenericEvent$1[]): Promise<number | undefined>;
-    getMarketRate(priceIndex: PriceIndex, satoshis: number | bigint): Promise<bigint>;
-    getRedemptionRate(priceIndex: PriceIndex, details: {
-        satoshis: bigint;
-        peggedPrice?: bigint;
-    }): Promise<bigint>;
-    getMarketRateApi(satoshis: bigint): Promise<bigint>;
-    getRedemptionRateApi(satoshis: bigint): Promise<bigint>;
-    getConfig(): Promise<IBitcoinLockConfig>;
-    getBitcoinConfirmedBlockHeight(): Promise<number>;
+type IQueryableClient = ArgonClient | ApiDecoration<'promise'>;
+declare class BitcoinLock implements IBitcoinLock {
+    utxoId: number;
+    p2wshScriptHashHex: string;
+    vaultId: number;
+    peggedPrice: bigint;
+    liquidityPromised: bigint;
+    ownerAccount: string;
+    satoshis: bigint;
+    vaultPubkey: string;
+    securityFees: bigint;
+    vaultClaimPubkey: string;
+    ownerPubkey: string;
+    vaultXpubSources: {
+        parentFingerprint: Uint8Array;
+        cosignHdIndex: number;
+        claimHdIndex: number;
+    };
+    vaultClaimHeight: number;
+    openClaimHeight: number;
+    createdAtHeight: number;
+    isVerified: boolean;
+    isRejectedNeedsRelease: boolean;
+    fundHoldExtensionsByBitcoinExpirationHeight: Record<number, bigint>;
+    constructor(data: IBitcoinLock);
     /**
      * Gets the UTXO reference by ID.
-     * @param utxoId - The UTXO ID to look up.
-     * @param clientAtHeight - Optional client at the block height to query the UTXO reference at a specific point in time.
+     * @param client - client at the block height to query the UTXO reference at a specific point in time.
      * @return An object containing the transaction ID and output index, or undefined if not found.
      * @return.txid - The Bitcoin transaction ID of the UTXO.
      * @return.vout - The output index of the UTXO in the transaction.
      * @return.bitcoinTxid - The Bitcoin transaction ID of the UTXO formatted in little endian
      */
-    getUtxoRef(utxoId: number, clientAtHeight?: ApiDecoration<'promise'>): Promise<{
+    getUtxoRef(client: IQueryableClient): Promise<{
         txid: string;
         vout: number;
         bitcoinTxid: string;
     } | undefined>;
-    getReleaseRequest(utxoId: number, clientAtHeight?: ApiDecoration<'promise'>): Promise<IReleaseRequestDetails | undefined>;
-    submitVaultSignature(args: {
-        utxoId: number;
-        vaultSignature: Uint8Array;
+    findPendingMints(client: IQueryableClient): Promise<bigint[]>;
+    getRatchetPrice(client: IQueryableClient, priceIndex: PriceIndex, vault: Vault): Promise<{
+        burnAmount: bigint;
+        ratchetingFee: bigint;
+        marketRate: bigint;
+    }>;
+    ratchet(args: {
+        client: ArgonClient;
+        priceIndex: PriceIndex;
+        argonKeyring: KeyringPair;
+        vault: Vault;
+    } & ISubmittableOptions): Promise<{
+        txResult: TxResult;
+        getRatchetResult: () => Promise<{
+            securityFee: bigint;
+            txFee: bigint;
+            newPeggedPrice: bigint;
+            liquidityPromised: bigint;
+            pendingMint: bigint;
+            burned: bigint;
+            blockHeight: number;
+            bitcoinBlockHeight: number;
+        }>;
+    }>;
+    releasePrice(priceIndex: PriceIndex): Promise<bigint>;
+    requestRelease(args: {
+        client: ArgonClient;
+        priceIndex: PriceIndex;
+        releaseRequest: IReleaseRequest;
         argonKeyring: KeyringPair;
     } & ISubmittableOptions): Promise<TxResult>;
-    getBitcoinLock(utxoId: number): Promise<IBitcoinLock | undefined>;
+    getReleaseRequest(client: IQueryableClient): Promise<IReleaseRequestDetails | undefined>;
     /**
      * Finds the cosign signature for a vault lock by UTXO ID. Optionally waits for the signature
-     * @param utxoId - The UTXO ID of the bitcoin lock
+     * @param client - The Argon client with rpc access
+     * @param finalizedStateOnly - If true, only checks finalized state
      * @param waitForSignatureMillis - Optional timeout in milliseconds to wait for the signature. If -1, waits indefinitely.
      */
-    findVaultCosignSignature(utxoId: number, waitForSignatureMillis?: number): Promise<{
+    findVaultCosignSignature(client: ArgonClient, finalizedStateOnly?: boolean, waitForSignatureMillis?: number): Promise<{
         blockHeight: number;
         signature: Uint8Array;
     } | undefined>;
-    blockHashAtHeight(atHeight: number): Promise<string | undefined>;
-    getVaultCosignSignature(utxoId: number, atHeight: number): Promise<Uint8Array | undefined>;
-    findPendingMints(utxoId: number): Promise<bigint[]>;
-    createInitializeLockTx(args: {
+    getVaultCosignSignature(client: ArgonClient, atHeight: number): Promise<Uint8Array | undefined>;
+    static getUtxoIdFromEvents(client: IQueryableClient, events: GenericEvent$1[]): Promise<number | undefined>;
+    static getMarketRate(priceIndex: PriceIndex, satoshis: number | bigint): Promise<bigint>;
+    static getRedemptionRate(priceIndex: PriceIndex, details: {
+        satoshis: bigint;
+        peggedPrice?: bigint;
+    }): Promise<bigint>;
+    static getConfig(client: IQueryableClient): Promise<IBitcoinLockConfig>;
+    static getBitcoinConfirmedBlockHeight(client: IQueryableClient): Promise<number>;
+    static submitVaultSignature(args: {
+        client: ArgonClient;
+        utxoId: number;
+        vaultSignature: Uint8Array;
+        argonKeyring: KeyringPair;
+    } & ISubmittableOptions): Promise<TxResult>;
+    static get(client: IQueryableClient, utxoId: number): Promise<BitcoinLock | undefined>;
+    static blockHashAtHeight(client: ArgonClient, atHeight: number): Promise<string | undefined>;
+    static createInitializeTx(args: {
+        client: ArgonClient;
         vault: Vault;
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
@@ -11679,12 +11731,8 @@ declare class BitcoinLocks {
         availableBalance: bigint;
         txFeePlusTip: bigint;
     }>;
-    getBitcoinLockFromTxResult(txResult: TxResult): Promise<{
-        lock: IBitcoinLock;
-        createdAtHeight: number;
-        txResult: TxResult;
-    }>;
-    initializeLock(args: {
+    static initialize(args: {
+        client: ArgonClient;
         vault: Vault;
         priceIndex: PriceIndex;
         ownerBitcoinPubkey: Uint8Array;
@@ -11692,46 +11740,18 @@ declare class BitcoinLocks {
         satoshis: bigint;
     } & ISubmittableOptions): Promise<{
         getLock(): Promise<{
-            lock: IBitcoinLock;
+            lock: BitcoinLock;
             createdAtHeight: number;
         }>;
         txResult: TxResult;
         securityFee: bigint;
     }>;
-    requiredSatoshisForArgonLiquidity(priceIndex: PriceIndex, argonAmount: bigint): Promise<bigint>;
-    requestRelease(args: {
-        lock: IBitcoinLock;
-        priceIndex: PriceIndex;
-        releaseRequest: IReleaseRequest;
-        argonKeyring: KeyringPair;
-    } & ISubmittableOptions): Promise<TxResult>;
-    releasePrice(priceIndex: PriceIndex, lock: {
-        satoshis: bigint;
-        peggedPrice: bigint;
-    }): Promise<bigint>;
-    getRatchetPrice(lock: IBitcoinLock, priceIndex: PriceIndex, vault: Vault): Promise<{
-        burnAmount: bigint;
-        ratchetingFee: bigint;
-        marketRate: bigint;
-    }>;
-    ratchet(args: {
-        lock: IBitcoinLock;
-        priceIndex: PriceIndex;
-        argonKeyring: KeyringPair;
-        vault: Vault;
-    } & ISubmittableOptions): Promise<{
+    static getBitcoinLockFromTxResult(client: IQueryableClient, txResult: TxResult): Promise<{
+        lock: BitcoinLock;
+        createdAtHeight: number;
         txResult: TxResult;
-        getRatchetResult: () => Promise<{
-            securityFee: bigint;
-            txFee: bigint;
-            newPeggedPrice: bigint;
-            liquidityPromised: bigint;
-            pendingMint: bigint;
-            burned: bigint;
-            blockHeight: number;
-            bitcoinBlockHeight: number;
-        }>;
     }>;
+    static requiredSatoshisForArgonLiquidity(priceIndex: PriceIndex, argonAmount: bigint): Promise<bigint>;
 }
 interface IBitcoinLockConfig {
     lockReleaseCosignDeadlineFrames: number;
@@ -11786,4 +11806,4 @@ declare function waitForLoad(): Promise<void>;
  */
 declare function getClient(host: string, options?: ApiOptions): Promise<ArgonClient>;
 
-export { type ArgonClient, BitcoinLocks, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };
+export { type ArgonClient, BitcoinLock, ExtrinsicError, FIXED_U128_DECIMALS, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, PERMILL_DECIMALS, PriceIndex, SATS_PER_BTC, TxResult, TxSubmitter, Vault, WageProtector, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getTickFromHeader, gettersToObject, keyringFromSuri, toFixedNumber, waitForLoad };