@argonprotocol/mainchain 1.4.12 → 1.4.13-dev.01d57087

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

@@ -30,6 +30,7 @@ import type {
   H160,
   H256,
   MultiAddress,
+  Percent,
 } from '@polkadot/types/interfaces/runtime';
 import type {
   ArgonPrimitivesBitcoinCompressedBitcoinPubkey,
@@ -38,7 +39,7 @@ import type {
   ArgonPrimitivesBitcoinUtxoRef,
   ArgonPrimitivesDomainZoneRecord,
   ArgonPrimitivesEthereumEthereumReceiptLogProofBatch,
-  ArgonPrimitivesInherentsBitcoinUtxoSync,
+  ArgonPrimitivesInherentsBitcoinUtxoSyncV2,
   ArgonPrimitivesInherentsBlockSealInherent,
   ArgonPrimitivesNotaryNotaryMeta,
   ArgonPrimitivesNotebookSignedNotebookHeader,
@@ -66,6 +67,7 @@ import type {
   PalletOperationalAccountsRegistration,
   PalletPriceIndexEthereumPriceIndex,
   PalletPriceIndexPriceIndex,
+  PalletTreasuryBondLotEarningsMetrics,
   PalletVaultsVaultConfig,
   SnowbridgeBeaconPrimitivesBeaconHeader,
   SpConsensusGrandpaEquivocationProof,
@@ -280,6 +282,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 +341,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.
+       * The Lock remains frozen until the exact cosigned transaction is observed on Bitcoin.
        *
        * 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 +371,7 @@ declare module '@polkadot/api-base/types/submittable' {
             | null
             | Uint8Array
             | PalletBitcoinLocksLockOptions
-            | { V1: any }
-            | { V2: any }
+            | { microgonsAtTargetPerBtc?: any; feeCoupon?: any }
             | string,
         ) => SubmittableExtrinsic<ApiType>,
         [
@@ -358,36 +381,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 +394,48 @@ 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 spend every current UTXO in a Lock. The exact external
+       * amount and network fee determine whether the transaction fully releases the Lock or
+       * returns one consolidated change output to the same Lock script. The vault operator has
+       * 10 days to publish one signature per frozen 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,
+          destinationSatoshis: u64 | AnyNumber | Uint8Array,
           bitcoinNetworkFee: u64 | AnyNumber | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
-        [u64, Bytes, u64]
+        [u64, Bytes, u64, 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)
@@ -486,12 +466,12 @@ declare module '@polkadot/api-base/types/submittable' {
       sync: AugmentedSubmittable<
         (
           utxoSync:
-            | ArgonPrimitivesInherentsBitcoinUtxoSync
+            | ArgonPrimitivesInherentsBitcoinUtxoSyncV2
             | { spent?: any; funded?: any; syncToBlock?: any }
             | string
             | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
-        [ArgonPrimitivesInherentsBitcoinUtxoSync]
+        [ArgonPrimitivesInherentsBitcoinUtxoSyncV2]
       >;
     };
     blockRewards: {
@@ -2026,6 +2006,37 @@ declare module '@polkadot/api-base/types/submittable' {
       >;
     };
     treasury: {
+      /**
+       * Attribute earnings already paid to a vault under the old aggregate flexible-bond model.
+       * This changes bond-lot metrics only; it never pays, holds, or releases funds. `expected`
+       * guards against overwriting a newer payout, and replaying `updated` is a no-op.
+       **/
+      backfillBondLotEarnings: AugmentedSubmittable<
+        (
+          bondLotId: u64 | AnyNumber | Uint8Array,
+          expected:
+            | PalletTreasuryBondLotEarningsMetrics
+            | {
+                participatedFrames?: any;
+                lastFrameEarningsFrameId?: any;
+                lastFrameEarnings?: any;
+                cumulativeEarnings?: any;
+              }
+            | string
+            | Uint8Array,
+          updated:
+            | PalletTreasuryBondLotEarningsMetrics
+            | {
+                participatedFrames?: any;
+                lastFrameEarningsFrameId?: any;
+                lastFrameEarnings?: any;
+                cumulativeEarnings?: any;
+              }
+            | string
+            | Uint8Array,
+        ) => SubmittableExtrinsic<ApiType>,
+        [u64, PalletTreasuryBondLotEarningsMetrics, PalletTreasuryBondLotEarningsMetrics]
+      >;
       /**
        * Buy whole bond units for the Argonot active set.
        **/
@@ -2036,7 +2047,7 @@ declare module '@polkadot/api-base/types/submittable' {
       /**
        * Buy whole `1 ARGON` bonds for a vault.
        *
-       * The purchase either enters the accepted list or fails.
+       * The purchase either creates a bond lot or fails.
        **/
       buyBonds: AugmentedSubmittable<
         (
@@ -2061,9 +2072,17 @@ declare module '@polkadot/api-base/types/submittable' {
         [u32, u32, Option<ArgonPrimitivesVaultTreasuryBonusApprovalProof>]
       >;
       /**
-       * Liquidate one full bond lot.
-       *
-       * The lot stops participating right away and is released after the delay.
+       * Update reward economics without resetting fields omitted by the caller.
+       **/
+      configureRewardEconomics: AugmentedSubmittable<
+        (
+          targetBitcoinPercent: Option<Percent> | null | Uint8Array | Percent | AnyNumber,
+        ) => SubmittableExtrinsic<ApiType>,
+        [Option<Percent>]
+      >;
+      /**
+       * Liquidate one full bond lot. It keeps the locked frame's payout terms and is
+       * released after the delay.
        **/
       liquidateBondLot: AugmentedSubmittable<
         (bondLotId: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
@@ -2291,8 +2310,8 @@ declare module '@polkadot/api-base/types/submittable' {
     };
     vaults: {
       /**
-       * Stop offering additional bitcoin locks from this vault. Will not affect existing
-       * locks. As funds are returned, they will be released to the vault owner.
+       * Stop offering new Bitcoin locks. Existing locks continue; securitization exits after
+       * its notice and any existing Bitcoin commitment.
        **/
       close: AugmentedSubmittable<
         (vaultId: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
@@ -2319,14 +2338,14 @@ declare module '@polkadot/api-base/types/submittable' {
         [PalletVaultsVaultConfig]
       >;
       /**
-       * Modify funds allocated by the vault. This will not affect issued bitcoin locks, but will
-       * affect the amount of funds available for new ones.
+       * Modify funds allocated by the vault without changing existing Bitcoin locks.
        *
        * The securitization percent must be maintained or increased.
        *
-       * The amount allocated may not go below the existing reserved amounts, but you can release
-       * funds in this vault as bitcoin locks are released. To stop issuing any more bitcoin
-       * locks, use the `close` api.
+       * Funds not yet used in a reward snapshot may leave without notice if not needed for
+       * Bitcoin commitments. Reward-committed funds require a one-year Bitcoin-height exit
+       * notice and remain held until both the notice and any Bitcoin commitment have ended.
+       * To stop issuing locks, use `close`.
        **/
       modifyFunding: AugmentedSubmittable<
         (
@@ -2345,7 +2364,7 @@ declare module '@polkadot/api-base/types/submittable' {
           vaultId: u32 | AnyNumber | Uint8Array,
           terms:
             | ArgonPrimitivesVaultVaultTerms
-            | { bitcoinAnnualPercentRate?: any; bitcoinBaseFee?: any; treasuryProfitSharing?: any }
+            | { bitcoinAnnualPercentRate?: any; bitcoinBaseFee?: any }
             | string
             | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
@@ -2363,7 +2382,11 @@ declare module '@polkadot/api-base/types/submittable' {
         ) => SubmittableExtrinsic<ApiType>,
         [u32, ArgonPrimitivesBitcoinOpaqueBitcoinXpub]
       >;
-      setCommittedArgonots: AugmentedSubmittable<
+      /**
+       * Set the desired Argonot backing. Unused funds release immediately; reward commitments
+       * withdraw after one-year notice, continuing to participate until released.
+       **/
+      setArgonotSecuritization: AugmentedSubmittable<
         (amount: Compact<u128> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
         [Compact<u128>]
       >;

package/src/interfaces/augment-api.ts

@@ -1,5 +1,4 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
-/* eslint-disable */
 
 import './augment-api-consts.js';
 import './augment-api-errors.js';

package/src/interfaces/augment-types.ts

@@ -1,5 +1,4 @@
 // Auto-generated via `yarn polkadot-types-from-defs`, do not edit
-/* eslint-disable */
 
 // import type lookup before we augment - in some environments
 // this is required to allow for ambient/previous definitions
@@ -67,7 +66,11 @@ import type {
   MoreAttestations,
 } from '@polkadot/types/interfaces/attestations';
 import type { RawAuraPreDigest } from '@polkadot/types/interfaces/aura';
-import type { ExtrinsicOrHash, ExtrinsicStatus } from '@polkadot/types/interfaces/author';
+import type {
+  ExtrinsicOrHash,
+  ExtrinsicStatus,
+  GeneratedSessionKeys,
+} from '@polkadot/types/interfaces/author';
 import type { UncleEntryItem } from '@polkadot/types/interfaces/authorship';
 import type {
   AllowedSlots,
@@ -651,6 +654,7 @@ import type {
   SessionStatus,
 } from '@polkadot/types/interfaces/mixnet';
 import type {
+  MmrAncestryProof,
   MmrBatchProof,
   MmrEncodableOpaqueLeaf,
   MmrError,
@@ -1868,6 +1872,7 @@ declare module '@polkadot/types/types/registry' {
     FungibilityV5: FungibilityV5;
     FungiblesAccessError: FungiblesAccessError;
     Gas: Gas;
+    GeneratedSessionKeys: GeneratedSessionKeys;
     GenesisBuildErr: GenesisBuildErr;
     GiltBid: GiltBid;
     GlobalValidationData: GlobalValidationData;
@@ -2034,6 +2039,7 @@ declare module '@polkadot/types/types/registry' {
     MigrationStatusResult: MigrationStatusResult;
     Mixnode: Mixnode;
     MixnodesErr: MixnodesErr;
+    MmrAncestryProof: MmrAncestryProof;
     MmrBatchProof: MmrBatchProof;
     MmrEncodableOpaqueLeaf: MmrEncodableOpaqueLeaf;
     MmrError: MmrError;