@argonprotocol/mainchain 1.4.9-dev.bc5f3764 → 1.4.9-dev.c62e171b

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/mainchain",
-  "version": "1.4.9-dev.bc5f3764",
+  "version": "1.4.9-dev.c62e171b",
   "description": "A client for accessing the Argon mainchain apis.",
   "repository": {
     "type": "git",
@@ -65,7 +65,7 @@
   },
   "devDependencies": {
     "@argonprotocol/ethereum-contracts": "workspace:*",
-    "@argonprotocol/testing": "1.4.9-dev.bc5f3764",
+    "@argonprotocol/testing": "1.4.9-dev.c62e171b",
     "@polkadot/typegen": "^16.5.6",
     "@substrate/ss58-registry": "^1.51.0",
     "@types/node": "^20",

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

@@ -301,14 +301,25 @@ declare module '@polkadot/api-base/types/consts' {
       targetPricePerSeat: u128 & AugmentedConst<ApiType>;
     };
     mint: {
+      /**
+       * The maximum share of a queued bitcoin mint that may be paid in a single frame.
+       **/
+      bitcoinMintPayoutPercentPerFrame: Percent & AugmentedConst<ApiType>;
       /**
        * The maximum number of mint histories to keep
        **/
       maxMintHistoryToMaintain: u32 & AugmentedConst<ApiType>;
       /**
-       * The maximum number of UTXOs that can be waiting for minting
+       * The maximum number of queued bitcoin mints that may receive payouts in a frame.
+       **/
+      maxPendingMintPayoutWindowSize: u32 & AugmentedConst<ApiType>;
+      /**
+       * The maximum number of queued mint entries a single bitcoin UTXO may accumulate.
+       **/
+      maxPendingMintsPerUtxo: u32 & AugmentedConst<ApiType>;
+      /**
+       * The maximum number of miners that can be paid in a frame.
        **/
-      maxPendingMintUtxos: u32 & AugmentedConst<ApiType>;
       maxPossibleMiners: u32 & AugmentedConst<ApiType>;
     };
     multisig: {
@@ -560,6 +571,14 @@ declare module '@polkadot/api-base/types/consts' {
       operationalFeeMultiplier: u8 & AugmentedConst<ApiType>;
     };
     treasury: {
+      /**
+       * The maximum number of active Argonot bond lots.
+       **/
+      maxActiveArgonotBondLots: u32 & AugmentedConst<ApiType>;
+      /**
+       * The maximum percent of ownership-token circulation that can be bonded.
+       **/
+      maxArgonotBondedPercentOfCirculation: Percent & AugmentedConst<ApiType>;
       /**
        * The maximum number of bond lots whose release delay may mature in a single frame.
        **/
@@ -580,6 +599,10 @@ declare module '@polkadot/api-base/types/consts' {
        * Treasury pallet id retained in metadata for account derivation.
        **/
       palletId: FrameSupportPalletId & AugmentedConst<ApiType>;
+      /**
+       * Percent of the full bid pool paid to Argonot bonds before vault distribution.
+       **/
+      percentForArgonotBondPool: Percent & AugmentedConst<ApiType>;
       /**
        * Percent of the bid pool reserved for treasury reserves.
        **/

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

@@ -1200,6 +1200,14 @@ declare module '@polkadot/api-base/types/errors' {
        * treasury backing.
        **/
       ActiveBondAmountBelowEncumberedBacking: AugmentedError<ApiType>;
+      /**
+       * The Argonot bond purchase would exceed the active circulation cap.
+       **/
+      ArgonotBondPurchaseAboveCap: AugmentedError<ApiType>;
+      /**
+       * The Argonot bond purchase did not beat the current active-set cutoff.
+       **/
+      ArgonotBondPurchaseBelowCutoff: AugmentedError<ApiType>;
       /**
        * The bond lot is already scheduled for release.
        **/

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

@@ -49,6 +49,7 @@ import type {
   PalletMintMintType,
   PalletMultisigTimepoint,
   PalletProxyDepositKind,
+  PalletTreasuryBondProgramId,
   PalletTreasuryBondReleaseReason,
   SpConsensusGrandpaAppPublic,
   SpRuntimeDispatchError,
@@ -1804,20 +1805,42 @@ declare module '@polkadot/api-base/types/events' {
     };
     treasury: {
       /**
-       * A bond purchase entered a vault's accepted list.
+       * A bond purchase entered its active program set.
        **/
       BondLotPurchased: AugmentedEvent<
         ApiType,
-        [vaultId: u32, bondLotId: u64, accountId: AccountId32, bonds: u32],
-        { vaultId: u32; bondLotId: u64; accountId: AccountId32; bonds: u32 }
+        [
+          programId: PalletTreasuryBondProgramId,
+          bondLotId: u64,
+          accountId: AccountId32,
+          bonds: u32,
+        ],
+        {
+          programId: PalletTreasuryBondProgramId;
+          bondLotId: u64;
+          accountId: AccountId32;
+          bonds: u32;
+        }
       >;
       /**
        * A bond lot was released.
        **/
       BondLotReleased: AugmentedEvent<
         ApiType,
-        [frameId: u64, vaultId: u32, bondLotId: u64, accountId: AccountId32, bonds: u32],
-        { frameId: u64; vaultId: u32; bondLotId: u64; accountId: AccountId32; bonds: u32 }
+        [
+          frameId: u64,
+          programId: PalletTreasuryBondProgramId,
+          bondLotId: u64,
+          accountId: AccountId32,
+          bonds: u32,
+        ],
+        {
+          frameId: u64;
+          programId: PalletTreasuryBondProgramId;
+          bondLotId: u64;
+          accountId: AccountId32;
+          bonds: u32;
+        }
       >;
       /**
        * A bond lot was removed from future frames and scheduled for release.
@@ -1825,7 +1848,7 @@ declare module '@polkadot/api-base/types/events' {
       BondLotReleaseScheduled: AugmentedEvent<
         ApiType,
         [
-          vaultId: u32,
+          programId: PalletTreasuryBondProgramId,
           bondLotId: u64,
           accountId: AccountId32,
           bonds: u32,
@@ -1833,7 +1856,7 @@ declare module '@polkadot/api-base/types/events' {
           reason: PalletTreasuryBondReleaseReason,
         ],
         {
-          vaultId: u32;
+          programId: PalletTreasuryBondProgramId;
           bondLotId: u64;
           accountId: AccountId32;
           bonds: u32;
@@ -1841,6 +1864,26 @@ declare module '@polkadot/api-base/types/events' {
           reason: PalletTreasuryBondReleaseReason;
         }
       >;
+      /**
+       * An error occurred while paying frame earnings for an Argonot bond lot.
+       **/
+      CouldNotDistributeEarningsToArgonotBondLot: AugmentedEvent<
+        ApiType,
+        [
+          frameId: u64,
+          bondLotId: u64,
+          accountId: AccountId32,
+          amount: u128,
+          dispatchError: SpRuntimeDispatchError,
+        ],
+        {
+          frameId: u64;
+          bondLotId: u64;
+          accountId: AccountId32;
+          amount: u128;
+          dispatchError: SpRuntimeDispatchError;
+        }
+      >;
       /**
        * An error occurred while paying frame earnings for a bond lot.
        **/
@@ -1870,7 +1913,7 @@ declare module '@polkadot/api-base/types/events' {
         ApiType,
         [
           frameId: u64,
-          vaultId: u32,
+          programId: PalletTreasuryBondProgramId,
           bondLotId: u64,
           amount: u128,
           accountId: AccountId32,
@@ -1878,7 +1921,7 @@ declare module '@polkadot/api-base/types/events' {
         ],
         {
           frameId: u64;
-          vaultId: u32;
+          programId: PalletTreasuryBondProgramId;
           bondLotId: u64;
           amount: u128;
           accountId: AccountId32;
@@ -1907,8 +1950,24 @@ declare module '@polkadot/api-base/types/events' {
        **/
       FrameEarningsDistributed: AugmentedEvent<
         ApiType,
-        [frameId: u64, bidPoolDistributed: u128, treasuryReserves: u128, participatingVaults: u32],
-        { frameId: u64; bidPoolDistributed: u128; treasuryReserves: u128; participatingVaults: u32 }
+        [
+          frameId: u64,
+          bidPoolDistributed: u128,
+          argonotBondPoolDistributed: u128,
+          vaultBidPoolDistributed: u128,
+          treasuryRefunds: u128,
+          treasuryReserves: u128,
+          participatingVaults: u32,
+        ],
+        {
+          frameId: u64;
+          bidPoolDistributed: u128;
+          argonotBondPoolDistributed: u128;
+          vaultBidPoolDistributed: u128;
+          treasuryRefunds: u128;
+          treasuryReserves: u128;
+          participatingVaults: u32;
+        }
       >;
       /**
        * The current frame's vault capital was locked in.

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

@@ -88,6 +88,8 @@ import type {
   PalletLocalchainTransferQueuedTransferOut,
   PalletMiningSlotMinerNonceScoring,
   PalletMintMintAction,
+  PalletMintMintQueueCursor,
+  PalletMintPendingMintUtxo,
   PalletMultisigMultisig,
   PalletOperationalAccountsOperationalAccount,
   PalletOperationalAccountsRewardsConfig,
@@ -99,6 +101,7 @@ import type {
   PalletTransactionPaymentReleases,
   PalletTreasuryBondLot,
   PalletTreasuryBondLotSummary,
+  PalletTreasuryFrameArgonotBondParticipants,
   PalletTreasuryFrameVaultCapital,
   PalletVaultsRecentCapacityDrop,
   PalletVaultsVaultFrameRevenue,
@@ -1105,15 +1108,36 @@ declare module '@polkadot/api-base/types/storage' {
        **/
       mintedMiningMicrogons: AugmentedQuery<ApiType, () => Observable<u128>, []>;
       /**
-       * Bitcoin UTXOs that have been submitted for minting. This list is FIFO for minting whenever
-       * a) CPI >= 0 and
-       * b) the aggregate minted Bitcoins <= the aggregate minted microgons from mining
+       * The next monotonic queue index to assign to a pending bitcoin mint.
        **/
-      pendingMintUtxos: AugmentedQuery<
+      nextPendingMintUtxoIndex: AugmentedQuery<ApiType, () => Observable<u64>, []>;
+      /**
+       * Queue bookkeeping for pending bitcoin mints, including the bounded payout start and the
+       * current frame scan cursor.
+       **/
+      pendingMintQueueState: AugmentedQuery<
         ApiType,
-        () => Observable<Vec<ITuple<[u64, AccountId32, u128]>>>,
+        () => Observable<PalletMintMintQueueCursor>,
         []
       >;
+      /**
+       * Reverse lookup from bitcoin UTXO id to all queued mint indices for direct removal and
+       * client lookup.
+       **/
+      pendingMintUtxoIdLookup: 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.
+       **/
+      pendingMintUtxosByIndex: AugmentedQuery<
+        ApiType,
+        (arg: u64 | AnyNumber | Uint8Array) => Observable<Option<PalletMintPendingMintUtxo>>,
+        [u64]
+      >;
     };
     multisig: {
       /**
@@ -1645,6 +1669,14 @@ declare module '@polkadot/api-base/types/storage' {
       >;
     };
     treasury: {
+      /**
+       * The active top Argonot bond lots kept in ascending bond order, then lower ids first.
+       **/
+      argonotBondLots: AugmentedQuery<
+        ApiType,
+        () => Observable<Vec<PalletTreasuryBondLotSummary>>,
+        []
+      >;
       /**
        * The stored state for each bond lot.
        **/
@@ -1674,6 +1706,16 @@ declare module '@polkadot/api-base/types/storage' {
         (arg: u32 | AnyNumber | Uint8Array) => Observable<Vec<PalletTreasuryBondLotSummary>>,
         [u32]
       >;
+      /**
+       * The Argonot bond participants locked for the current frame.
+       *
+       * Payout uses this to see which Argonot bond lots are participating in the frame.
+       **/
+      currentFrameArgonotBondParticipants: AugmentedQuery<
+        ApiType,
+        () => Observable<Option<PalletTreasuryFrameArgonotBondParticipants>>,
+        []
+      >;
       /**
        * The vault capital locked for the current frame.
        *
@@ -1713,6 +1755,10 @@ declare module '@polkadot/api-base/types/storage' {
         (arg: u64 | AnyNumber | Uint8Array) => Observable<Vec<u64>>,
         [u64]
       >;
+      /**
+       * The total number of active Argonot bonds in the active set.
+       **/
+      totalActiveArgonotBonds: AugmentedQuery<ApiType, () => Observable<u32>, []>;
     };
     txPause: {
       /**

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

@@ -2002,6 +2002,13 @@ declare module '@polkadot/api-base/types/submittable' {
       >;
     };
     treasury: {
+      /**
+       * Buy whole bond units for the Argonot active set.
+       **/
+      buyArgonotBonds: AugmentedSubmittable<
+        (bonds: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
+        [u32]
+      >;
       /**
        * Buy whole `1 ARGON` bonds for a vault.
        *