@argonprotocol/mainchain 1.4.3-dev.4408f4ff → 1.4.3-dev.5e4d8d6a

package/browser/index.d.ts

@@ -2180,7 +2180,7 @@ declare module '@polkadot/api-base/types/events' {
                 vaultId: u32,
                 liquidityPromised: u128,
                 securitization: u128,
-                lockedMarketRate: u128,
+                lockedTargetPrice: u128,
                 accountId: AccountId32,
                 securityFee: u128
             ], {
@@ -2188,7 +2188,7 @@ declare module '@polkadot/api-base/types/events' {
                 vaultId: u32;
                 liquidityPromised: u128;
                 securitization: u128;
-                lockedMarketRate: u128;
+                lockedTargetPrice: u128;
                 accountId: AccountId32;
                 securityFee: u128;
             }>;
@@ -2196,18 +2196,18 @@ declare module '@polkadot/api-base/types/events' {
                 utxoId: u64,
                 vaultId: u32,
                 liquidityPromised: u128,
-                originalMarketRate: u128,
+                oldTargetPrice: u128,
                 securityFee: u128,
-                newLockedMarketRate: u128,
+                newTargetPrice: u128,
                 amountBurned: u128,
                 accountId: AccountId32
             ], {
                 utxoId: u64;
                 vaultId: u32;
                 liquidityPromised: u128;
-                originalMarketRate: u128;
+                oldTargetPrice: u128;
                 securityFee: u128;
-                newLockedMarketRate: u128;
+                newTargetPrice: u128;
                 amountBurned: u128;
                 accountId: AccountId32;
             }>;
@@ -3955,7 +3955,7 @@ declare module '@polkadot/api-base/types/storage' {
                 u64
             ]>;
             /**
-             * History of microgons per btc
+             * History of target microgons per btc.
              **/
             microgonPerBtcHistory: AugmentedQuery<ApiType, () => Observable<Vec<ITuple<[u64, u128]>>>, [
             ]>;
@@ -9393,7 +9393,7 @@ declare module '@polkadot/types/lookup' {
             readonly vaultId: u32;
             readonly liquidityPromised: u128;
             readonly securitization: u128;
-            readonly lockedMarketRate: u128;
+            readonly lockedTargetPrice: u128;
             readonly accountId: AccountId32;
             readonly securityFee: u128;
         } & Struct;
@@ -9402,9 +9402,9 @@ declare module '@polkadot/types/lookup' {
             readonly utxoId: u64;
             readonly vaultId: u32;
             readonly liquidityPromised: u128;
-            readonly originalMarketRate: u128;
+            readonly oldTargetPrice: u128;
             readonly securityFee: u128;
-            readonly newLockedMarketRate: u128;
+            readonly newTargetPrice: u128;
             readonly amountBurned: u128;
             readonly accountId: AccountId32;
         } & Struct;
@@ -10869,7 +10869,7 @@ declare module '@polkadot/types/lookup' {
     interface PalletBitcoinLocksLockOptions extends Enum {
         readonly isV1: boolean;
         readonly asV1: {
-            readonly microgonsPerBtc: Option<u128>;
+            readonly microgonsAtTargetPerBtc: Option<u128>;
         } & Struct;
         readonly type: 'V1';
     }
@@ -11745,7 +11745,7 @@ declare module '@polkadot/types/lookup' {
     interface PalletBitcoinLocksLockedBitcoin extends Struct {
         readonly vaultId: Compact<u32>;
         readonly liquidityPromised: Compact<u128>;
-        readonly lockedMarketRate: Compact<u128>;
+        readonly lockedTargetPrice: Compact<u128>;
         readonly ownerAccount: AccountId32;
         readonly securitizationRatio: u128;
         readonly securityFees: Compact<u128>;
@@ -11771,7 +11771,7 @@ declare module '@polkadot/types/lookup' {
         readonly bitcoinNetworkFee: Compact<u64>;
         readonly cosignDueFrame: Compact<u64>;
         readonly toScriptPubkey: Bytes;
-        readonly redemptionPrice: Compact<u128>;
+        readonly redemptionAmount: Compact<u128>;
     }
     /** @name PalletBitcoinLocksOrphanedUtxo (399) */
     interface PalletBitcoinLocksOrphanedUtxo extends Struct {
@@ -12385,6 +12385,19 @@ declare function dispatchErrorToExtrinsicError(client: ArgonClient, error: IDisp
  * @returns A promise that resolves if the extrinsic was successful, and rejects if it failed
  */
 declare function checkForExtrinsicSuccess(events: EventRecord[], client: ArgonClient): Promise<void>;
+/**
+ * Return a bigint value using a canonical field first, then named fallback fields on the same source object.
+ * Helpful when reading runtime records that may use older field names across spec versions.
+ * @param value The preferred bigint-like value, usually from the current field name
+ * @param source The object to read fallback fields from
+ * @param fallbackFields The fallback field names to check in order
+ * @param fallback The value to return if no preferred or fallback field is present
+ * @returns The preferred or fallback value converted to bigint
+ */
+declare function getBigIntFallback<T extends object>(value: IBigIntLike | undefined, source: T, fallbackFields: readonly string[], fallback?: bigint): bigint;
+type IBigIntLike = bigint | {
+    toBigInt(): bigint;
+};
 
 type ITxProgressCallback = (progressToInBlock: number, result?: TxResult) => void;
 declare class TxResult {
@@ -12581,7 +12594,8 @@ declare class PriceIndex {
     argonTimeWeightedAverageLiquidity?: BigNumber;
     lastUpdatedTick?: number;
     load(client: ArgonClient | ApiDecoration<'promise'>): Promise<this>;
-    getBtcMicrogonPrice(satoshis: bigint | number): bigint;
+    getSatoshiPriceInMarketMicrogons(satoshis: bigint | number): bigint;
+    getSatoshiPriceInTargetMicrogons(satoshis: bigint | number): bigint;
     get rValue(): BigNumber;
     get argonCpi(): BigNumber;
 }
@@ -12596,7 +12610,7 @@ declare class BitcoinLock implements IBitcoinLock {
     utxoId: number;
     p2wshScriptHashHex: string;
     vaultId: number;
-    lockedMarketRate: bigint;
+    lockedTargetPrice: bigint;
     liquidityPromised: bigint;
     ownerAccount: string;
     satoshis: bigint;
@@ -12631,23 +12645,22 @@ declare class BitcoinLock implements IBitcoinLock {
         bitcoinTxid: string;
     } | undefined>;
     findPendingMints(client: IQueryableClient): Promise<bigint[]>;
-    getRatchetPrice(client: IQueryableClient, priceIndex: PriceIndex, vault: Vault): Promise<{
+    calculateRatchetingCosts(client: IQueryableClient, priceIndex: PriceIndex, vault: Vault, microgonsAtTargetPerBtc?: bigint): Promise<{
         burnAmount: bigint;
         ratchetingFee: bigint;
-        marketRate: bigint;
     }>;
     ratchet(args: {
         client: ArgonClient;
         priceIndex: PriceIndex;
         txSigner: TxSigningAccount;
         vault: Vault;
-        microgonsPerBtc?: bigint;
+        microgonsAtTargetPerBtc?: bigint;
     } & ISubmittableOptions): Promise<{
         txResult: TxResult;
         getRatchetResult: () => Promise<{
             securityFee: bigint;
             txFee: bigint;
-            newLockedMarketRate: bigint;
+            lockedTargetPrice: bigint;
             liquidityPromised: bigint;
             pendingMint: bigint;
             burned: bigint;
@@ -12655,7 +12668,7 @@ declare class BitcoinLock implements IBitcoinLock {
             bitcoinBlockHeight: number;
         }>;
     }>;
-    releasePrice(priceIndex: PriceIndex): Promise<bigint>;
+    calculateRedemptionAmount(priceIndex: PriceIndex): bigint;
     requestRelease(args: {
         client: ArgonClient;
         priceIndex: PriceIndex;
@@ -12675,11 +12688,8 @@ declare class BitcoinLock implements IBitcoinLock {
     } | undefined>;
     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;
-        lockedMarketRate?: bigint;
-    }): Promise<bigint>;
+    static calculateRedemptionAmountFromSatoshis(priceIndex: PriceIndex, satoshis: bigint, lockedTargetPrice?: bigint): bigint;
+    static calculateRedemptionAmount(priceIndex: PriceIndex, btcMicrogonsAtTarget: bigint, maxMicrogonsAtTarget?: bigint): bigint;
     static getConfig(client: IQueryableClient): Promise<IBitcoinLockConfig>;
     static getBitcoinConfirmedBlockHeight(client: IQueryableClient): Promise<number>;
     static submitVaultSignature(args: {
@@ -12719,7 +12729,7 @@ declare class BitcoinLock implements IBitcoinLock {
         satoshis: bigint;
         txSigner: TxSigningAccount;
         reducedBalanceBy?: bigint;
-        microgonsPerBtc?: bigint;
+        microgonsAtTargetPerBtc?: bigint;
         tip?: bigint;
         initializeForAccountId?: string;
     }): Promise<{
@@ -12766,13 +12776,13 @@ interface IReleaseRequest {
 interface IReleaseRequestDetails extends IReleaseRequest {
     dueFrame: number;
     vaultId: number;
-    redemptionPrice: bigint;
+    redemptionAmount: bigint;
 }
 interface IBitcoinLock {
     utxoId: number;
     p2wshScriptHashHex: string;
     vaultId: number;
-    lockedMarketRate: bigint;
+    lockedTargetPrice: bigint;
     liquidityPromised: bigint;
     ownerAccount: string;
     satoshis: bigint;
@@ -12880,4 +12890,4 @@ declare function waitForLoad(): Promise<void>;
 declare function getClient(host: string, options?: ApiOptions): Promise<ArgonClient>;
 declare function getOfflineRegistry(): TypeRegistry;
 
-export { type ArgonClient, BitcoinLock, type EthereumEventLocator, type EthereumEventProof, type EthereumExecutionClient, type EthereumReceipt, type EthereumVerifyEventLogResult, ExtrinsicError, FIXED_U128_DECIMALS, type IArgonQueryable, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, MINTING_GATEWAY_BURN_FOR_TRANSFER_EVENT_NAME, MINTING_GATEWAY_RUNTIME_DECIMALS, MINTING_GATEWAY_RUNTIME_TO_ERC20_SCALE, MINTING_GATEWAY_TOKEN_DECIMALS, PERMILL_DECIMALS, PriceIndex, type RetainedExecutionAnchor, SATS_PER_BTC, TxResult, type TxSigningAccount, TxSubmitter, Vault, WageProtector, buildEthereumEventProof, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, findEthereumBurnForTransferLogIndex, formatArgons, fromFixedNumber, getAuthorFromHeader, getClient, getEthereumBeaconSyncBootstrapTx, getEthereumBeaconSyncState, getFrameInfoFromHeader, getLatestRetainedAnchor, getNextEthereumBeaconSyncTxs, getOfflineRegistry, getTickFromHeader, gettersToObject, isOutdatedTransactionError, keyringFromSuri, mintingGatewayArtifact, toFixedNumber, waitForLoad, waitForRetainedExecutionAnchor };
+export { type ArgonClient, BitcoinLock, type EthereumEventLocator, type EthereumEventProof, type EthereumExecutionClient, type EthereumReceipt, type EthereumVerifyEventLogResult, ExtrinsicError, FIXED_U128_DECIMALS, type IArgonQueryable, type IBitcoinLock, type IBitcoinLockConfig, type IReleaseRequest, type IReleaseRequestDetails, type ISubmittableOptions, type ITerms, type ITxProgressCallback, MICROGONS_PER_ARGON, MINTING_GATEWAY_BURN_FOR_TRANSFER_EVENT_NAME, MINTING_GATEWAY_RUNTIME_DECIMALS, MINTING_GATEWAY_RUNTIME_TO_ERC20_SCALE, MINTING_GATEWAY_TOKEN_DECIMALS, PERMILL_DECIMALS, PriceIndex, type RetainedExecutionAnchor, SATS_PER_BTC, TxResult, type TxSigningAccount, TxSubmitter, Vault, WageProtector, buildEthereumEventProof, checkForExtrinsicSuccess, createKeyringPair, dispatchErrorToExtrinsicError, dispatchErrorToString, findEthereumBurnForTransferLogIndex, formatArgons, fromFixedNumber, getAuthorFromHeader, getBigIntFallback, getClient, getEthereumBeaconSyncBootstrapTx, getEthereumBeaconSyncState, getFrameInfoFromHeader, getLatestRetainedAnchor, getNextEthereumBeaconSyncTxs, getOfflineRegistry, getTickFromHeader, gettersToObject, isOutdatedTransactionError, keyringFromSuri, mintingGatewayArtifact, toFixedNumber, waitForLoad, waitForRetainedExecutionAnchor };