@argonprotocol/mainchain 1.4.13-dev.6ac99b65 → 1.4.13-dev.754f4641

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/mainchain",
-  "version": "1.4.13-dev.6ac99b65",
+  "version": "1.4.13-dev.754f4641",
   "description": "A client for accessing the Argon mainchain apis.",
   "repository": {
     "type": "git",
@@ -21,6 +21,7 @@
     "tsc": "yarn workspace @argonprotocol/ethereum-contracts build && yarn generate:contract-declarations && tsup && yarn validate:package",
     "tsup": "yarn tsc",
     "validate:package": "tsx src/scripts/validatePackage.ts",
+    "backfill:flexible-bond-metrics": "tsx src/scripts/backfillFlexibleBondMetrics.ts",
     "watch": "yarn generate:contract-declarations && tsup --watch",
     "typecheck": "tsc --noEmit -p tsconfig.test.json"
   },
@@ -67,7 +68,7 @@
   },
   "devDependencies": {
     "@argonprotocol/ethereum-contracts": "workspace:*",
-    "@argonprotocol/testing": "1.4.13-dev.6ac99b65",
+    "@argonprotocol/testing": "1.4.13-dev.754f4641",
     "@polkadot/typegen": "^17.0.1",
     "@substrate/ss58-registry": "^1.51.0",
     "@types/node": "^20",

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

@@ -1,5 +1,4 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
-/* eslint-disable */
 
 // import type lookup before we augment - in some environments
 // this is required to allow for ambient/previous definitions
@@ -8,7 +7,7 @@ import type {} from '@polkadot/api-base/types/consts';
 import type { ApiTypes, AugmentedConst } from '@polkadot/api-base/types';
 import type { u128, u16, u32, u64, u8 } from '@polkadot/types-codec';
 import type { ITuple } from '@polkadot/types-codec/types';
-import type { AccountId32, Percent } from '@polkadot/types/interfaces/runtime';
+import type { AccountId32, Percent, Permill } from '@polkadot/types/interfaces/runtime';
 import type {
   FrameSupportPalletId,
   FrameSystemLimitsBlockLength,
@@ -371,6 +370,10 @@ declare module '@polkadot/api-base/types/consts' {
       metaChangesTickDelay: u64 & AugmentedConst<ApiType>;
     };
     operationalAccounts: {
+      /**
+       * Allowed Bitcoin valuation shortfall below the liquidity minimum.
+       **/
+      bitcoinLiquidityTolerance: Percent & AugmentedConst<ApiType>;
       /**
        * Additional argon amount (base units) required per follow-on access code after an account
        * becomes operational.
@@ -385,7 +388,7 @@ declare module '@polkadot/api-base/types/consts' {
        **/
       maxAvailableAccessCodes: u32 & AugmentedConst<ApiType>;
       /**
-       * Minimum bitcoin amount required to register.
+       * Minimum Bitcoin-backed ARGON liquidity required to register and activate.
        **/
       minimumBitcoin: u128 & AugmentedConst<ApiType>;
       /**
@@ -591,10 +594,18 @@ declare module '@polkadot/api-base/types/consts' {
       operationalFeeMultiplier: u8 & AugmentedConst<ApiType>;
     };
     treasury: {
+      /**
+       * Default percent of maximum Bitcoin-mintable Argons targeted by the network.
+       **/
+      defaultTargetBitcoinPercent: Percent & AugmentedConst<ApiType>;
       /**
        * The maximum number of active Argonot bond lots.
        **/
       maxActiveArgonotBondLots: u32 & AugmentedConst<ApiType>;
+      /**
+       * Maximum live Argon bond lots while direct frame payouts iterate every lot.
+       **/
+      maxArgonBondLots: u32 & AugmentedConst<ApiType>;
       /**
        * The maximum percent of ownership-token circulation that can be bonded.
        **/
@@ -603,10 +614,6 @@ declare module '@polkadot/api-base/types/consts' {
        * The maximum number of bond lots whose release delay may mature in a single frame.
        **/
       maxPendingUnlocksPerFrame: u32 & AugmentedConst<ApiType>;
-      /**
-       * The maximum number of accepted bond lots in a vault's accepted bond-lot list.
-       **/
-      maxTreasuryContributors: u32 & AugmentedConst<ApiType>;
       /**
        * The maximum number of vaults that can participate in one frame's locked vault capital.
        **/
@@ -620,13 +627,29 @@ declare module '@polkadot/api-base/types/consts' {
        **/
       palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
       /**
-       * Percent of the full bid pool paid to Argonot bonds before vault distribution.
+       * Maximum percent paid to Argon bonds when the network target is filled.
+       **/
+      percentForArgonBondPool: Percent & AugmentedConst<ApiType>;
+      /**
+       * Percent reserved for Bitcoin Liquids and burned in this release.
+       **/
+      percentForBitcoinLiquidPool: Percent & AugmentedConst<ApiType>;
+      /**
+       * Percent reserved for future mining-operator rewards and burned in this release.
+       **/
+      percentForMiningOperatorPool: Percent & AugmentedConst<ApiType>;
+      /**
+       * Percent of the full bid pool paid to Argonot Stakes.
        **/
-      percentForArgonotBondPool: Percent & AugmentedConst<ApiType>;
+      percentForStakePool: Percent & AugmentedConst<ApiType>;
       /**
        * Percent of the bid pool reserved for treasury reserves.
        **/
       percentForTreasuryReserves: Percent & AugmentedConst<ApiType>;
+      /**
+       * Maximum percent paid to vaults when the network target is filled.
+       **/
+      percentForVaultPool: Percent & AugmentedConst<ApiType>;
       /**
        * The number of frames a releasing bond lot remains held before release.
        **/
@@ -635,6 +658,9 @@ declare module '@polkadot/api-base/types/consts' {
        * Account that holds treasury reserves for claims and reserve-funded payouts.
        **/
       treasuryReservesAccount: AccountId32 & AugmentedConst<ApiType>;
+      upstreamBitcoinTarget: u128 & AugmentedConst<ApiType>;
+      upstreamBitcoinWeight: Permill & AugmentedConst<ApiType>;
+      upstreamBondTarget: u128 & AugmentedConst<ApiType>;
     };
     txPause: {
       /**
@@ -651,6 +677,10 @@ declare module '@polkadot/api-base/types/consts' {
       batchedCallsLimit: u32 & AugmentedConst<ApiType>;
     };
     vaults: {
+      /**
+       * Bitcoin blocks in the term of a newly created Bitcoin lock.
+       **/
+      bitcoinLockDurationBlocks: u64 & AugmentedConst<ApiType>;
       /**
        * Max concurrent cosigns pending per vault
        **/
@@ -664,17 +694,17 @@ declare module '@polkadot/api-base/types/consts' {
        **/
       maxVaults: u32 & AugmentedConst<ApiType>;
       /**
-       * Duration to keep the operational minimum securitization locked from vault creation.
-       **/
-      operationalMinimumVaultLockTicks: u64 & AugmentedConst<ApiType>;
-      /**
-       * Minimum vault securitization required while the operational floor lock is active.
+       * Vault securitization committed when the operator becomes operational.
        **/
       operationalMinimumVaultSecuritization: u128 & AugmentedConst<ApiType>;
       /**
        * The number of frames within which revenue must be collected
        **/
       revenueCollectionExpirationFrames: u64 & AugmentedConst<ApiType>;
+      /**
+       * Bitcoin blocks in the securitization exit notice period.
+       **/
+      securitizationExitNoticeBlocks: u64 & AugmentedConst<ApiType>;
     };
   } // AugmentedConsts
 } // declare module

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

@@ -1361,10 +1361,18 @@ declare module '@polkadot/api-base/types/errors' {
        * The bond lot is already scheduled for release.
        **/
       BondLotAlreadyReleasing: AugmentedError<ApiType>;
+      /**
+       * Historical metrics can only be backfilled for vault bond lots.
+       **/
+      BondLotCannotBeBackfilled: AugmentedError<ApiType>;
       /**
        * Only an active vault bond owned by its operator can be used as flexible.
        **/
       BondLotCannotBeFlexible: AugmentedError<ApiType>;
+      /**
+       * The lot's metrics changed since the backfill was calculated.
+       **/
+      BondLotMetricsChanged: AugmentedError<ApiType>;
       /**
        * The bond lot could not be found.
        **/
@@ -1381,10 +1389,6 @@ declare module '@polkadot/api-base/types/errors' {
        * The bonus approval nonce has already been consumed or superseded.
        **/
       BonusApprovalAlreadyUsed: AugmentedError<ApiType>;
-      /**
-       * The approved bonus plus the vault's profit sharing exceeds 100%.
-       **/
-      BonusApprovalExceedsProfitSharing: AugmentedError<ApiType>;
       /**
        * The bonus approval already expired.
        **/
@@ -1398,21 +1402,29 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       BonusApprovalWrongVault: AugmentedError<ApiType>;
       /**
-       * The vault doesn't have enough bitcoin security to support this bond purchase
+       * The vault doesn't have enough raw securitization to support this bond purchase.
        **/
       InsufficientBondSpace: AugmentedError<ApiType>;
       /**
        * An internal error occurred.
        **/
       InternalError: AugmentedError<ApiType>;
+      /**
+       * The proposed backfill would reduce or corrupt the lot's earnings metrics.
+       **/
+      InvalidBondLotMetrics: AugmentedError<ApiType>;
       /**
        * The bonus approval signature is invalid or unauthorized.
        **/
       InvalidBonusApprovalSignature: AugmentedError<ApiType>;
       /**
-       * The vault already has the maximum number of accepted bond lots.
+       * The network has reached the direct-payout vault bond lot admission limit.
+       **/
+      MaxArgonBondLotsExceeded: AugmentedError<ApiType>;
+      /**
+       * The vault already has the maximum number of flexible bond lots.
        **/
-      MaxAcceptedBondLotsExceeded: AugmentedError<ApiType>;
+      MaxFlexibleBondLotsExceeded: AugmentedError<ApiType>;
       /**
        * Too many bond lot releases are scheduled for the same frame.
        **/
@@ -1461,13 +1473,13 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       AccountBelowMinimumBalance: AugmentedError<ApiType>;
       /**
-       * Bitcoin conversion to compressed pubkey failed
+       * Held Argonots cannot be reduced below the amount already crosschain-encumbered.
        **/
-      BitcoinConversionFailed: AugmentedError<ApiType>;
+      ArgonotsBelowEncumberedBacking: AugmentedError<ApiType>;
       /**
-       * Committed Argonots cannot be reduced below the amount already crosschain-encumbered.
+       * Bitcoin conversion to compressed pubkey failed
        **/
-      CommittedArgonotsBelowEncumberedBacking: AugmentedError<ApiType>;
+      BitcoinConversionFailed: AugmentedError<ApiType>;
       /**
        * A funding change is already scheduled
        **/

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

@@ -21,7 +21,7 @@ import type {
   u64,
 } from '@polkadot/types-codec';
 import type { ITuple } from '@polkadot/types-codec/types';
-import type { AccountId32, H160, H256 } from '@polkadot/types/interfaces/runtime';
+import type { AccountId32, H160, H256, Percent } from '@polkadot/types/interfaces/runtime';
 import type {
   ArgonNotaryAuditErrorVerifyError,
   ArgonPrimitivesBitcoinUtxoRef,
@@ -1916,6 +1916,15 @@ declare module '@polkadot/api-base/types/events' {
       >;
     };
     treasury: {
+      /**
+       * Historical flexible-bond earnings were attributed to a surviving vault lot. No funds
+       * move.
+       **/
+      BondLotEarningsBackfilled: AugmentedEvent<
+        ApiType,
+        [bondLotId: u64, addedFrames: u32, addedEarnings: u128],
+        { bondLotId: u64; addedFrames: u32; addedEarnings: u128 }
+      >;
       BondLotFlexibilityChanged: AugmentedEvent<
         ApiType,
         [vaultId: u32, bondLotId: u64, isFlexible: bool],
@@ -1981,6 +1990,14 @@ declare module '@polkadot/api-base/types/events' {
           reason: PalletTreasuryBondReleaseReason;
         }
       >;
+      /**
+       * A fixed or unearned reward allocation could not be burned.
+       **/
+      CouldNotBurnRewardAllocation: AugmentedEvent<
+        ApiType,
+        [frameId: u64, amount: u128, dispatchError: SpRuntimeDispatchError],
+        { frameId: u64; amount: u128; dispatchError: SpRuntimeDispatchError }
+      >;
       /**
        * An error occurred while paying frame earnings for an Argonot bond lot.
        **/
@@ -2070,18 +2087,20 @@ declare module '@polkadot/api-base/types/events' {
         [
           frameId: u64,
           bidPoolDistributed: u128,
-          argonotBondPoolDistributed: u128,
-          vaultBidPoolDistributed: u128,
-          treasuryRefunds: u128,
+          stakePoolDistributed: u128,
+          argonBondPoolDistributed: u128,
+          vaultPoolDistributed: u128,
+          burned: u128,
           treasuryReserves: u128,
           participatingVaults: u32,
         ],
         {
           frameId: u64;
           bidPoolDistributed: u128;
-          argonotBondPoolDistributed: u128;
-          vaultBidPoolDistributed: u128;
-          treasuryRefunds: u128;
+          stakePoolDistributed: u128;
+          argonBondPoolDistributed: u128;
+          vaultPoolDistributed: u128;
+          burned: u128;
           treasuryReserves: u128;
           participatingVaults: u32;
         }
@@ -2091,14 +2110,19 @@ declare module '@polkadot/api-base/types/events' {
        **/
       FrameVaultCapitalLocked: AugmentedEvent<
         ApiType,
-        [frameId: u64, totalEligibleBonds: u128, participatingVaults: u32],
-        { frameId: u64; totalEligibleBonds: u128; participatingVaults: u32 }
+        [frameId: u64, totalActiveBonds: u128, participatingVaults: u32],
+        { frameId: u64; totalActiveBonds: u128; participatingVaults: u32 }
       >;
       ReservedBondSpaceChanged: AugmentedEvent<
         ApiType,
         [vaultId: u32, reservedBondSpace: u32],
         { vaultId: u32; reservedBondSpace: u32 }
       >;
+      RewardEconomicsConfigured: AugmentedEvent<
+        ApiType,
+        [targetBitcoinPercent: Percent],
+        { targetBitcoinPercent: Percent }
+      >;
     };
     txPause: {
       /**
@@ -2170,7 +2194,17 @@ declare module '@polkadot/api-base/types/events' {
       >;
     };
     vaults: {
-      CommittedArgonotsSet: AugmentedEvent<
+      ArgonotExitReleased: AugmentedEvent<
+        ApiType,
+        [vaultId: u32, amount: u128],
+        { vaultId: u32; amount: u128 }
+      >;
+      ArgonotExitRequested: AugmentedEvent<
+        ApiType,
+        [vaultId: u32, amount: u128, noticeEndsAt: u64],
+        { vaultId: u32; amount: u128; noticeEndsAt: u64 }
+      >;
+      ArgonotSecuritizationSet: AugmentedEvent<
         ApiType,
         [vaultId: u32, operatorAccountId: AccountId32, amount: u128],
         { vaultId: u32; operatorAccountId: AccountId32; amount: u128 }
@@ -2212,6 +2246,16 @@ declare module '@polkadot/api-base/types/events' {
         [vaultId: u32, reservedSecuritizationSpace: u128],
         { vaultId: u32; reservedSecuritizationSpace: u128 }
       >;
+      SecuritizationExitReleased: AugmentedEvent<
+        ApiType,
+        [vaultId: u32, amount: u128],
+        { vaultId: u32; amount: u128 }
+      >;
+      SecuritizationExitRequested: AugmentedEvent<
+        ApiType,
+        [vaultId: u32, amount: u128, noticeEndsAt: u64],
+        { vaultId: u32; amount: u128; noticeEndsAt: u64 }
+      >;
       SecuritizationReserved: AugmentedEvent<
         ApiType,
         [

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

@@ -1,5 +1,4 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
-/* eslint-disable */
 
 // import type lookup before we augment - in some environments
 // this is required to allow for ambient/previous definitions
@@ -22,9 +21,10 @@ import type {
   u8,
 } from '@polkadot/types-codec';
 import type { AnyNumber, ITuple } from '@polkadot/types-codec/types';
-import type { AccountId32, H160, H256 } from '@polkadot/types/interfaces/runtime';
+import type { AccountId32, H160, H256, Percent } from '@polkadot/types/interfaces/runtime';
 import type {
   ArgonNotaryAuditErrorVerifyError,
+  ArgonPrimitivesAmountRankAmountRankKey,
   ArgonPrimitivesBalanceChangeAccountOrigin,
   ArgonPrimitivesBitcoinBitcoinBlock,
   ArgonPrimitivesBitcoinBitcoinCosignScriptPubkey,
@@ -50,8 +50,9 @@ import type {
   ArgonPrimitivesNotaryNotaryRecord,
   ArgonPrimitivesProvidersBlockSealerInfo,
   ArgonPrimitivesTickTicker,
+  ArgonPrimitivesTreasuryPositionQuantities,
   ArgonPrimitivesVault,
-  ArgonPrimitivesVaultVaultArgonotCommitment,
+  ArgonPrimitivesVaultVaultArgonotSecuritization,
   FrameSupportDispatchPerDispatchClassWeight,
   FrameSupportTokensFungibleImbalance,
   FrameSupportTokensMiscIdAmountRuntimeFreezeReason,
@@ -112,6 +113,7 @@ import type {
   PalletTreasuryBondLotSummary,
   PalletTreasuryFrameArgonotBondParticipants,
   PalletTreasuryFrameVaultCapital,
+  PalletTreasuryPositionsPosition,
   PalletTreasuryVaultBondState,
   PalletVaultsVaultFrameRevenue,
   SpConsensusGrandpaAppPublic,
@@ -1202,13 +1204,9 @@ declare module '@polkadot/api-base/types/storage' {
        **/
       miningMintPerCohort: AugmentedQuery<ApiType, () => Observable<BTreeMap<u64, u128>>, []>;
       /**
-       * The total amount of Bitcoin microgons minted. Cannot exceed `MintedMiningMicrogons`.
+       * Bitcoin-minted Argons that have not been explicitly repaid through Fission settlement.
        **/
       mintedBitcoinMicrogons: AugmentedQuery<ApiType, () => Observable<u128>, []>;
-      /**
-       * The total amount of microgons minted for mining
-       **/
-      mintedMiningMicrogons: AugmentedQuery<ApiType, () => Observable<u128>, []>;
       /**
        * The next monotonic queue index to assign to a pending bitcoin mint.
        **/
@@ -1797,12 +1795,22 @@ declare module '@polkadot/api-base/types/storage' {
         ) => Observable<Option<Null>>,
         [AccountId32, u64]
       >;
+      /**
+       * Live Argon bond lot ids associated with a vault, including lots awaiting release. Direct
+       * frame payouts iterate this admission-bounded index.
+       **/
+      bondLotIdsByVault: AugmentedQuery<
+        ApiType,
+        (
+          arg1: u32 | AnyNumber | Uint8Array,
+          arg2: u64 | AnyNumber | Uint8Array,
+        ) => Observable<Option<Null>>,
+        [u32, u64]
+      >;
       /**
        * The active bond state for a vault.
        *
-       * The bounded payout set keeps the largest bond amount first, then lower `bond_lot_id` first
-       * when amounts tie. Flexible lots remain in `BondLotById` and are represented here by their
-       * aggregate.
+       * Admission totals and flexible displacement; individual lots live in `BondLotById`.
        **/
       bondLotsByVault: AugmentedQuery<
         ApiType,
@@ -1820,9 +1828,7 @@ declare module '@polkadot/api-base/types/storage' {
         []
       >;
       /**
-       * The vault capital locked for the current frame.
-       *
-       * Payout uses this to see which vaults and bond lots are participating in the frame.
+       * The network bond total and vault capital locked for the current frame's payout.
        **/
       currentFrameVaultCapital: AugmentedQuery<
         ApiType,
@@ -1867,9 +1873,36 @@ declare module '@polkadot/api-base/types/storage' {
         [u64]
       >;
       /**
-       * The total number of active Argonot bonds in the active set.
+       * Configurable percent of maximum Bitcoin-mintable Argons targeted by the network.
+       **/
+      targetBitcoinPercent: AugmentedQuery<ApiType, () => Observable<Percent>, []>;
+      /**
+       * Live Argon bond lots, including those awaiting release; stakes have a separate admission
+       * limit.
+       **/
+      totalArgonBondLots: AugmentedQuery<ApiType, () => Observable<u32>, []>;
+    };
+    treasuryPositions: {
+      /**
+       * Maintained network quantities, updated together with their account contributions.
+       * Treasury reads these when freezing frame inputs. This replaces its live Argonot stake total.
+       **/
+      networkTotals: AugmentedQuery<
+        ApiType,
+        () => Observable<ArgonPrimitivesTreasuryPositionQuantities>,
+        []
+      >;
+      /**
+       * Maintained source quantities keyed by the actual position owner. Upstream quantities belong
+       * to the linked vault account; primary and mining account balances are separate owners.
        **/
-      totalActiveArgonotBonds: AugmentedQuery<ApiType, () => Observable<u32>, []>;
+      positionsByAccount: AugmentedQuery<
+        ApiType,
+        (
+          arg: AccountId32 | string | Uint8Array,
+        ) => Observable<Option<PalletTreasuryPositionsPosition>>,
+        [AccountId32]
+      >;
     };
     txPause: {
       /**
@@ -1885,13 +1918,13 @@ declare module '@polkadot/api-base/types/storage' {
     };
     vaults: {
       /**
-       * Vault-side committed and crosschain-encumbered argonot backing.
+       * Argonots held for the vault, with reward commitments and cross-chain encumbrances.
        **/
-      argonotCommitmentByVaultId: AugmentedQuery<
+      argonotSecuritizationByVaultId: AugmentedQuery<
         ApiType,
         (
           arg: u32 | AnyNumber | Uint8Array,
-        ) => Observable<Option<ArgonPrimitivesVaultVaultArgonotCommitment>>,
+        ) => Observable<Option<ArgonPrimitivesVaultVaultArgonotSecuritization>>,
         [u32]
       >;
       /**
@@ -1942,6 +1975,10 @@ declare module '@polkadot/api-base/types/storage' {
         [u32]
       >;
       revenuePerFrameByVaultCount: AugmentedQuery<ApiType, () => Observable<u32>, []>;
+      /**
+       * Raw securitization across all open vaults, including those below the payout cutoff.
+       **/
+      totalVaultSecuritization: AugmentedQuery<ApiType, () => Observable<u128>, []>;
       /**
        * The vaults that have funds releasing at a given bitcoin height
        **/
@@ -1967,12 +2004,18 @@ declare module '@polkadot/api-base/types/storage' {
         [u32]
       >;
       /**
-       * Vaults whose temporary operational minimum may be released at a given tick.
+       * Open vaults ordered by raw securitization (largest first), then vault ID.
        **/
-      vaultsReleasingOperationalMinimumByTick: AugmentedQuery<
+      vaultSecuritizationRanks: AugmentedQuery<
         ApiType,
-        (arg: u64 | AnyNumber | Uint8Array) => Observable<BTreeSet<u32>>,
-        [u64]
+        (
+          arg:
+            | ArgonPrimitivesAmountRankAmountRankKey
+            | { descendingAmount?: any; orderedId?: any }
+            | string
+            | Uint8Array,
+        ) => Observable<Option<Null>>,
+        [ArgonPrimitivesAmountRankAmountRankKey]
       >;
       /**
        * Vault Bitcoin Xpub and current child counter by VaultId

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

@@ -1,5 +1,4 @@
 // Auto-generated via `yarn polkadot-types-from-chain`, do not edit
-/* eslint-disable */
 
 // import type lookup before we augment - in some environments
 // this is required to allow for ambient/previous definitions