@argonprotocol/mainchain 1.4.12-dev.8cae3588 → 1.4.12-dev.a0735a19

package/src/interfaces/augment-api-query.ts

@@ -27,10 +27,11 @@ import type {
   ArgonNotaryAuditErrorVerifyError,
   ArgonPrimitivesBalanceChangeAccountOrigin,
   ArgonPrimitivesBitcoinBitcoinBlock,
+  ArgonPrimitivesBitcoinBitcoinCosignScriptPubkey,
   ArgonPrimitivesBitcoinBitcoinNetwork,
   ArgonPrimitivesBitcoinBitcoinXPub,
+  ArgonPrimitivesBitcoinUtxoAddress,
   ArgonPrimitivesBitcoinUtxoRef,
-  ArgonPrimitivesBitcoinUtxoValue,
   ArgonPrimitivesBlockSealBlockPayout,
   ArgonPrimitivesBlockSealMiningBidStats,
   ArgonPrimitivesBlockSealMiningRegistration,
@@ -63,6 +64,7 @@ import type {
   PalletBalancesAccountData,
   PalletBalancesBalanceLock,
   PalletBalancesReserveData,
+  PalletBitcoinFissionsFission,
   PalletBitcoinLocksLockReleaseRequest,
   PalletBitcoinLocksLockedBitcoin,
   PalletBitcoinLocksOrphanedUtxo,
@@ -92,7 +94,7 @@ import type {
   PalletMiningSlotMinerNonceScoring,
   PalletMintMintAction,
   PalletMintMintQueueCursor,
-  PalletMintPendingMintUtxo,
+  PalletMintPendingBitcoinMint,
   PalletMultisigMultisig,
   PalletOperationalAccountsOperationalAccount,
   PalletOperationalAccountsRewardsConfig,
@@ -209,6 +211,35 @@ declare module '@polkadot/api-base/types/storage' {
        **/
       totalIssuance: AugmentedQuery<ApiType, () => Observable<u128>, []>;
     };
+    bitcoinFissions: {
+      /**
+       * Active Fission records addressed by their owner and owner-local Fission ID.
+       **/
+      fissionByOwnerAndId: AugmentedQuery<
+        ApiType,
+        (
+          arg1: AccountId32 | string | Uint8Array,
+          arg2: u64 | AnyNumber | Uint8Array,
+        ) => Observable<Option<PalletBitcoinFissionsFission>>,
+        [AccountId32, u64]
+      >;
+      /**
+       * Active Fission IDs allocating satoshis from each Lock.
+       **/
+      fissionIdsByLockId: AugmentedQuery<
+        ApiType,
+        (arg: u64 | AnyNumber | Uint8Array) => Observable<BTreeSet<u64>>,
+        [u64]
+      >;
+      /**
+       * Minimum Fission ID accepted from each owner.
+       **/
+      nextFissionIdByOwner: AugmentedQuery<
+        ApiType,
+        (arg: AccountId32 | string | Uint8Array) => Observable<u64>,
+        [AccountId32]
+      >;
+    };
     bitcoinLocks: {
       lastFeeCouponNonceByVaultAndAccount: AugmentedQuery<
         ApiType,
@@ -218,6 +249,14 @@ declare module '@polkadot/api-base/types/storage' {
         ) => Observable<Option<u64>>,
         [u32, AccountId32]
       >;
+      /**
+       * Highest Bitcoin UTXO sync height processed for securitization hold expirations.
+       **/
+      lastProcessedSecuritizationHoldBitcoinHeight: AugmentedQuery<
+        ApiType,
+        () => Observable<Option<u64>>,
+        []
+      >;
       /**
        * Utxos that have been requested to be cosigned for releasing
        **/
@@ -235,6 +274,28 @@ declare module '@polkadot/api-base/types/storage' {
         (arg: u64 | AnyNumber | Uint8Array) => Observable<BTreeSet<u64>>,
         [u64]
       >;
+      /**
+       * Index of active UTXO IDs per owner account.
+       **/
+      lockIdsByOwnerAccount: AugmentedQuery<
+        ApiType,
+        (
+          arg1: AccountId32 | string | Uint8Array,
+          arg2: u64 | AnyNumber | Uint8Array,
+        ) => Observable<Option<Null>>,
+        [AccountId32, u64]
+      >;
+      /**
+       * Index of active UTXO IDs per vault
+       **/
+      lockIdsByVaultId: AugmentedQuery<
+        ApiType,
+        (
+          arg1: u32 | AnyNumber | Uint8Array,
+          arg2: u64 | AnyNumber | Uint8Array,
+        ) => Observable<Option<Null>>,
+        [u32, u64]
+      >;
       /**
        * Stores the block number where a release was cosigned by the vault.
        **/
@@ -246,7 +307,7 @@ declare module '@polkadot/api-base/types/storage' {
       /**
        * Stores bitcoin locks that have requested to be released
        **/
-      lockReleaseRequestsByUtxoId: AugmentedQuery<
+      lockReleaseRequestsById: AugmentedQuery<
         ApiType,
         (
           arg: u64 | AnyNumber | Uint8Array,
@@ -256,13 +317,13 @@ declare module '@polkadot/api-base/types/storage' {
       /**
        * Stores bitcoin utxos that have requested to be released
        **/
-      locksByUtxoId: AugmentedQuery<
+      locksById: AugmentedQuery<
         ApiType,
         (arg: u64 | AnyNumber | Uint8Array) => Observable<Option<PalletBitcoinLocksLockedBitcoin>>,
         [u64]
       >;
       /**
-       * History of target microgons per btc.
+       * Recent target-normalized microgon values per BTC and their observed ticks.
        **/
       microgonPerBtcHistory: AugmentedQuery<
         ApiType,
@@ -270,10 +331,10 @@ declare module '@polkadot/api-base/types/storage' {
         []
       >;
       /**
-       * The minimum number of satoshis that can be locked
+       * The minimum number of satoshis accepted in one watched funding UTXO.
        **/
       minimumSatoshis: AugmentedQuery<ApiType, () => Observable<u64>, []>;
-      nextUtxoId: AugmentedQuery<ApiType, () => Observable<Option<u64>>, []>;
+      nextBitcoinLockId: AugmentedQuery<ApiType, () => Observable<Option<u64>>, []>;
       /**
        * Expiration of orphaned utxo refs by user account
        **/
@@ -300,26 +361,13 @@ declare module '@polkadot/api-base/types/storage' {
         [AccountId32, ArgonPrimitivesBitcoinUtxoRef]
       >;
       /**
-       * Index of active UTXO IDs per owner account.
+       * Lock IDs whose securitization hold expires at the indexed Bitcoin height.
+       * Expiry releases only the unactivated portion and leaves the lock address watched.
        **/
-      utxoIdsByOwnerAccount: AugmentedQuery<
+      securitizationHoldExpirationsByBitcoinHeight: AugmentedQuery<
         ApiType,
-        (
-          arg1: AccountId32 | string | Uint8Array,
-          arg2: u64 | AnyNumber | Uint8Array,
-        ) => Observable<Option<Null>>,
-        [AccountId32, u64]
-      >;
-      /**
-       * Index of active UTXO IDs per vault
-       **/
-      utxoIdsByVaultId: AugmentedQuery<
-        ApiType,
-        (
-          arg1: u32 | AnyNumber | Uint8Array,
-          arg2: u64 | AnyNumber | Uint8Array,
-        ) => Observable<Option<Null>>,
-        [u32, u64]
+        (arg: u64 | AnyNumber | Uint8Array) => Observable<BTreeSet<u64>>,
+        [u64]
       >;
     };
     bitcoinUtxos: {
@@ -331,16 +379,6 @@ declare module '@polkadot/api-base/types/storage' {
         () => Observable<ArgonPrimitivesBitcoinBitcoinNetwork>,
         []
       >;
-      /**
-       * Candidate UTXOs associated with a lock (mismatches, extra funding, etc.).
-       **/
-      candidateUtxoRefsByUtxoId: AugmentedQuery<
-        ApiType,
-        (
-          arg: u64 | AnyNumber | Uint8Array,
-        ) => Observable<BTreeMap<ArgonPrimitivesBitcoinUtxoRef, u64>>,
-        [u64]
-      >;
       /**
        * An oracle-provided confirmed bitcoin block (eg, 6 blocks back)
        **/
@@ -349,42 +387,23 @@ declare module '@polkadot/api-base/types/storage' {
         () => Observable<Option<ArgonPrimitivesBitcoinBitcoinBlock>>,
         []
       >;
-      /**
-       * Pending funding entries that have expired. These remain watched until their additional
-       * orphan-detection window ends, then await bounded cleanup.
-       **/
-      expiredPendingFunding: AugmentedQuery<
-        ApiType,
-        () => Observable<BTreeMap<u64, ArgonPrimitivesBitcoinUtxoValue>>,
-        []
-      >;
       /**
        * Check if the inherent was included
        **/
       inherentIncluded: AugmentedQuery<ApiType, () => Observable<bool>, []>;
       /**
-       * Locked Bitcoin UTXOs that have been funded with a UtxoRef from the Bitcoin network and
-       * amounts within the MinimumSatoshiThreshold of the expected. If a Bitcoin UTXO is moved
-       * before the expiration block, the funds are burned and the UTXO is unlocked.
+       * The Lock ID identified by each watched script pubkey.
        **/
-      lockedUtxos: AugmentedQuery<
+      lockIdByScriptPubkey: AugmentedQuery<
         ApiType,
         (
           arg:
-            | ArgonPrimitivesBitcoinUtxoRef
-            | { txid?: any; outputIndex?: any }
+            | ArgonPrimitivesBitcoinBitcoinCosignScriptPubkey
+            | { P2WSH: any }
             | string
             | Uint8Array,
-        ) => Observable<Option<ArgonPrimitivesBitcoinUtxoValue>>,
-        [ArgonPrimitivesBitcoinUtxoRef]
-      >;
-      /**
-       * Bitcoin locks that are pending full funding on the bitcoin network
-       **/
-      locksPendingFunding: AugmentedQuery<
-        ApiType,
-        () => Observable<BTreeMap<u64, ArgonPrimitivesBitcoinUtxoValue>>,
-        []
+        ) => Observable<Option<u64>>,
+        [ArgonPrimitivesBitcoinBitcoinCosignScriptPubkey]
       >;
       /**
        * Bitcoin Oracle Operator Account
@@ -408,11 +427,21 @@ declare module '@polkadot/api-base/types/storage' {
        **/
       tempParentHasSyncState: AugmentedQuery<ApiType, () => Observable<bool>, []>;
       /**
-       * A mapping of utxo id to the confirmed utxo reference
+       * Watched Lock addresses and the scan height needed to observe them.
        **/
-      utxoIdToFundingUtxoRef: AugmentedQuery<
+      utxoAddressByLockId: AugmentedQuery<
         ApiType,
-        (arg: u64 | AnyNumber | Uint8Array) => Observable<Option<ArgonPrimitivesBitcoinUtxoRef>>,
+        (
+          arg: u64 | AnyNumber | Uint8Array,
+        ) => Observable<Option<ArgonPrimitivesBitcoinUtxoAddress>>,
+        [u64]
+      >;
+      /**
+       * Every output observed at a watched Lock address, retained until explicitly removed.
+       **/
+      utxoRefsByLockId: AugmentedQuery<
+        ApiType,
+        (arg: u64 | AnyNumber | Uint8Array) => Observable<BTreeSet<ArgonPrimitivesBitcoinUtxoRef>>,
         [u64]
       >;
     };
@@ -1169,33 +1198,33 @@ declare module '@polkadot/api-base/types/storage' {
       /**
        * The next monotonic queue index to assign to a pending bitcoin mint.
        **/
-      nextPendingMintUtxoIndex: AugmentedQuery<ApiType, () => Observable<u64>, []>;
+      nextPendingBitcoinMintIndex: AugmentedQuery<ApiType, () => Observable<u64>, []>;
       /**
-       * Queue bookkeeping for pending bitcoin mints, including the bounded payout start and the
-       * current frame scan cursor.
+       * Bitcoin UTXOs that have been submitted for minting, keyed by a monotonic queue index so
+       * payouts can preserve FIFO order while each frame works through a fixed payout cohort.
        **/
-      pendingMintQueueState: AugmentedQuery<
+      pendingBitcoinMintsByIndex: AugmentedQuery<
         ApiType,
-        () => Observable<PalletMintMintQueueCursor>,
-        []
+        (arg: u64 | AnyNumber | Uint8Array) => Observable<Option<PalletMintPendingBitcoinMint>>,
+        [u64]
       >;
       /**
        * Reverse lookup from bitcoin UTXO id to all queued mint indices for direct removal and
        * client lookup.
        **/
-      pendingMintUtxoIdLookup: AugmentedQuery<
+      pendingMintIndicesByLockId: AugmentedQuery<
         ApiType,
         (arg: u64 | AnyNumber | Uint8Array) => Observable<Vec<u64>>,
         [u64]
       >;
       /**
-       * Bitcoin UTXOs that have been submitted for minting, keyed by a monotonic queue index so
-       * payouts can preserve FIFO order while each frame works through a fixed payout cohort.
+       * Queue bookkeeping for pending bitcoin mints, including the bounded payout start and the
+       * current frame scan cursor.
        **/
-      pendingMintUtxosByIndex: AugmentedQuery<
+      pendingMintQueueState: AugmentedQuery<
         ApiType,
-        (arg: u64 | AnyNumber | Uint8Array) => Observable<Option<PalletMintPendingMintUtxo>>,
-        [u64]
+        () => Observable<PalletMintMintQueueCursor>,
+        []
       >;
     };
     multisig: {

package/src/interfaces/augment-api-tx.ts

@@ -280,6 +280,38 @@ declare module '@polkadot/api-base/types/submittable' {
         [Vec<AccountId32>]
       >;
     };
+    bitcoinFissions: {
+      /**
+       * Close a Fission without moving Bitcoin and remove its active record.
+       **/
+      close: AugmentedSubmittable<
+        (fissionId: Compact<u64> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
+        [Compact<u64>]
+      >;
+      /**
+       * Create a Fission from one owner-held Lock and associate it with a Liquid ID.
+       **/
+      create: AugmentedSubmittable<
+        (
+          fissionId: Compact<u64> | AnyNumber | Uint8Array,
+          liquidId: Compact<u64> | AnyNumber | Uint8Array,
+          lockId: Compact<u64> | AnyNumber | Uint8Array,
+          satoshis: Compact<u64> | AnyNumber | Uint8Array,
+          microgonsAtTargetPerBtc: Compact<u128> | AnyNumber | Uint8Array,
+        ) => SubmittableExtrinsic<ApiType>,
+        [Compact<u64>, Compact<u64>, Compact<u64>, Compact<u64>, Compact<u128>]
+      >;
+      /**
+       * Ratchet an active Fission to a replacement target-normalized BTC value.
+       **/
+      ratchet: AugmentedSubmittable<
+        (
+          fissionId: Compact<u64> | AnyNumber | Uint8Array,
+          microgonsAtTargetPerBtc: Compact<u128> | AnyNumber | Uint8Array,
+        ) => SubmittableExtrinsic<ApiType>,
+        [Compact<u64>, Compact<u128>]
+      >;
+    };
     bitcoinLocks: {
       adminModifyMinimumLockedSats: AugmentedSubmittable<
         (satoshis: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
@@ -307,37 +339,27 @@ declare module '@polkadot/api-base/types/submittable' {
         [AccountId32, ArgonPrimitivesBitcoinUtxoRef, Bytes]
       >;
       /**
-       * Submitted by a Vault operator to cosign the release of a bitcoin utxo. The Bitcoin owner
-       * release fee will be burned, and the lock will be allowed to expire without a penalty.
+       * Submitted by a Vault operator to cosign every input in a Bitcoin Lock release. The
+       * signatures must follow ascending `UtxoRef` order: transaction ID, then output index.
+       * Its securitization will be scheduled for release without a penalty.
        *
        * This is submitted as a no-fee transaction off chain to allow keys to remain in cold
        * wallets.
        **/
       cosignRelease: AugmentedSubmittable<
         (
-          utxoId: u64 | AnyNumber | Uint8Array,
-          signature: Bytes | string | Uint8Array,
-        ) => SubmittableExtrinsic<ApiType>,
-        [u64, Bytes]
-      >;
-      increaseSecuritization: AugmentedSubmittable<
-        (
-          utxoId: u64 | AnyNumber | Uint8Array,
-          newSatoshis: Compact<u64> | AnyNumber | Uint8Array,
+          lockId: u64 | AnyNumber | Uint8Array,
+          signatures: Vec<Bytes> | (Bytes | string | Uint8Array)[],
         ) => SubmittableExtrinsic<ApiType>,
-        [u64, Compact<u64>]
+        [u64, Vec<Bytes>]
       >;
       /**
-       * Initialize a bitcoin lock. This will create a LockedBitcoin for the submitting account
-       * and log the Bitcoin Script hash to Events.
+       * Create a Bitcoin receive address backed by a Lock for the submitting account.
        *
        * The pubkey submitted here will be used to create a script pubkey that will be used in a
        * timelock multisig script to lock the bitcoin.
-       *
-       * NOTE: A "lock-er" must send btc to the cosigner UTXO address to "complete" the
-       * LockedBitcoin and be added to the Bitcoin Mint line.
        **/
-      initialize: AugmentedSubmittable<
+      createReceiveAddress: AugmentedSubmittable<
         (
           vaultId: u32 | AnyNumber | Uint8Array,
           satoshis: Compact<u64> | AnyNumber | Uint8Array,
@@ -347,8 +369,7 @@ declare module '@polkadot/api-base/types/submittable' {
             | null
             | Uint8Array
             | PalletBitcoinLocksLockOptions
-            | { V1: any }
-            | { V2: any }
+            | { microgonsAtTargetPerBtc?: any; feeCoupon?: any }
             | string,
         ) => SubmittableExtrinsic<ApiType>,
         [
@@ -358,36 +379,6 @@ declare module '@polkadot/api-base/types/submittable' {
           Option<PalletBitcoinLocksLockOptions>,
         ]
       >;
-      /**
-       * Ratcheting allows a user to change the lock price of their bitcoin lock. This is
-       * functionally the same as releasing and re-initializing, but it allows a user to skip
-       * sending transactions through bitcoin and any associated fees. It also allows you to stay
-       * on your original lock expiration without having to pay the full year of fees again.
-       *
-       * Ratcheting "down" - when the price of bitcoin is lower than your lock price, you pay the
-       * full release price and get added back to the mint queue at the current market rate. You
-       * pocket the difference between the already minted "lock price" and the new market value
-       * (which you just had burned). Your new lock price is set to the market low, so you can
-       * take advantage of ratchets "up" in the future.
-       *
-       * Ratcheting "up" - when the price of bitcoin is higher than your lock price, you pay a
-       * prorated fee for the remainder of your existing lock duration. You are added to the mint
-       * queue for the difference in your new lock price vs the previous lock price.
-       **/
-      ratchet: AugmentedSubmittable<
-        (
-          utxoId: u64 | AnyNumber | Uint8Array,
-          options:
-            | Option<PalletBitcoinLocksLockOptions>
-            | null
-            | Uint8Array
-            | PalletBitcoinLocksLockOptions
-            | { V1: any }
-            | { V2: any }
-            | string,
-        ) => SubmittableExtrinsic<ApiType>,
-        [u64, Option<PalletBitcoinLocksLockOptions>]
-      >;
       requestOrphanedUtxoRelease: AugmentedSubmittable<
         (
           utxoRef:
@@ -401,61 +392,47 @@ declare module '@polkadot/api-base/types/submittable' {
         [ArgonPrimitivesBitcoinUtxoRef, Bytes, u64]
       >;
       /**
-       * Submitted by a Bitcoin holder to trigger the release of their Utxo out of the cosign
-       * script. A transaction spending the UTXO should be pre-created so that the sighash
-       * can be submitted here. The vault operator will have 10 days to counter-sign the
-       * transaction. It will be published with the public key as a BitcoinUtxoCosigned Event.
+       * Submitted by a Bitcoin holder to release every UTXO in a Lock from its cosign script.
+       * The destination and fee determine the transaction the vault must sign. The vault
+       * operator has 10 days to publish one signature per input in a BitcoinUtxoCosigned
+       * event.
        *
        * Owner must submit a script pubkey and also a fee to pay to the bitcoin network.
        **/
       requestRelease: AugmentedSubmittable<
         (
-          utxoId: u64 | AnyNumber | Uint8Array,
+          lockId: u64 | AnyNumber | Uint8Array,
           toScriptPubkey: Bytes | string | Uint8Array,
           bitcoinNetworkFee: u64 | AnyNumber | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
         [u64, Bytes, u64]
       >;
-      setFlexible: AugmentedSubmittable<
-        (
-          utxoId: u64 | AnyNumber | Uint8Array,
-          isFlexible: bool | boolean | Uint8Array,
-        ) => SubmittableExtrinsic<ApiType>,
-        [u64, bool]
-      >;
-    };
-    bitcoinUtxos: {
       /**
-       * Bind a candidate UTXO ref as the funding UTXO for its lock.
-       * The locks pallet authorizes the promotion; this pallet binds the ref and begins
-       * tracking.
+       * Replace this Lock's BTC coverage and target value for its remaining term.
        **/
-      fundWithUtxoCandidate: AugmentedSubmittable<
+      resecuritize: AugmentedSubmittable<
         (
-          utxoId: u64 | AnyNumber | Uint8Array,
-          utxoRef:
-            | ArgonPrimitivesBitcoinUtxoRef
-            | { txid?: any; outputIndex?: any }
-            | string
-            | Uint8Array,
+          lockId: u64 | AnyNumber | Uint8Array,
+          satoshis: Compact<u64> | AnyNumber | Uint8Array,
+          options:
+            | Option<PalletBitcoinLocksLockOptions>
+            | null
+            | Uint8Array
+            | PalletBitcoinLocksLockOptions
+            | { microgonsAtTargetPerBtc?: any; feeCoupon?: any }
+            | string,
         ) => SubmittableExtrinsic<ApiType>,
-        [u64, ArgonPrimitivesBitcoinUtxoRef]
+        [u64, Compact<u64>, Option<PalletBitcoinLocksLockOptions>]
       >;
-      /**
-       * Reject a pending candidate UTXO and materialize it as an orphan through the locks
-       * pallet.
-       **/
-      rejectUtxoCandidate: AugmentedSubmittable<
+      setFlexible: AugmentedSubmittable<
         (
-          utxoId: u64 | AnyNumber | Uint8Array,
-          utxoRef:
-            | ArgonPrimitivesBitcoinUtxoRef
-            | { txid?: any; outputIndex?: any }
-            | string
-            | Uint8Array,
+          lockId: u64 | AnyNumber | Uint8Array,
+          isFlexible: bool | boolean | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
-        [u64, ArgonPrimitivesBitcoinUtxoRef]
+        [u64, bool]
       >;
+    };
+    bitcoinUtxos: {
       /**
        * Sets the most recent confirmed bitcoin block height (only executable by the Oracle
        * Operator account)