@argonprotocol/mainchain 1.4.11 → 1.4.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/mainchain",
-  "version": "1.4.11",
+  "version": "1.4.12",
   "description": "A client for accessing the Argon mainchain apis.",
   "repository": {
     "type": "git",
@@ -14,11 +14,14 @@
   "homepage": "https://github.com/argonprotocol/mainchain#readme",
   "scripts": {
     "build": "yarn generate:defs && yarn generate:meta && node clean-build.js && yarn tsc",
+    "generate:contract-declarations": "tsc -p tsconfig.contracts.json",
     "generate:defs": "polkadot-types-from-defs --endpoint metadata.json --input ./src/interfaces --package @argonprotocol/mainchain/interfaces",
     "generate:meta": "polkadot-types-from-chain --endpoint metadata.json --output ./src/interfaces --package @argonprotocol/mainchain/interfaces --strict",
     "test": "vitest --run --config vitest.config.ts",
-    "tsc": "yarn workspace @argonprotocol/ethereum-contracts build && tsup",
-    "watch": "tsup --watch",
+    "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",
+    "watch": "yarn generate:contract-declarations && tsup --watch",
     "typecheck": "tsc --noEmit -p tsconfig.test.json"
   },
   "files": [
@@ -65,7 +68,7 @@
   },
   "devDependencies": {
     "@argonprotocol/ethereum-contracts": "workspace:*",
-    "@argonprotocol/testing": "1.4.11",
+    "@argonprotocol/testing": "1.4.12",
     "@polkadot/typegen": "^16.5.6",
     "@substrate/ss58-registry": "^1.51.0",
     "@types/node": "^20",

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

@@ -103,7 +103,8 @@ declare module '@polkadot/api-base/types/consts' {
        **/
       maximumSatoshiThresholdFromExpected: u64 & AugmentedConst<ApiType>;
       /**
-       * Maximum bitcoin blocks to watch a Utxo for confirmation before canceling
+       * Maximum bitcoin blocks to accept a UTXO for confirmation. Expired locks remain watched
+       * for this many additional blocks so late funding can be detected as orphaned.
        **/
       maxPendingConfirmationBlocks: u64 & AugmentedConst<ApiType>;
       /**
@@ -375,6 +376,10 @@ declare module '@polkadot/api-base/types/consts' {
        * becomes operational.
        **/
       bitcoinLockSizeForAccessCode: u128 & AugmentedConst<ApiType>;
+      /**
+       * Maximum number of accrued access codes awarded at one frame boundary.
+       **/
+      maxAccessCodeAwardsPerFrame: u32 & AugmentedConst<ApiType>;
       /**
        * Maximum number of available access codes allowed at once.
        **/
@@ -646,11 +651,6 @@ declare module '@polkadot/api-base/types/consts' {
       batchedCallsLimit: u32 & AugmentedConst<ApiType>;
     };
     vaults: {
-      /**
-       * One no-fee stale `initialize_for` failure is allowed for each this-many units of lost
-       * `available_for_lock`.
-       **/
-      capacityDropAttemptUnit: u128 & AugmentedConst<ApiType>;
       /**
        * Max concurrent cosigns pending per vault
        **/
@@ -659,10 +659,6 @@ declare module '@polkadot/api-base/types/consts' {
        * The max pending vault term changes per block
        **/
       maxPendingTermModificationsPerTick: u32 & AugmentedConst<ApiType>;
-      /**
-       * Maximum number of recent `available_for_lock` drops retained per vault.
-       **/
-      maxRecentCapacityDropsPerVault: u32 & AugmentedConst<ApiType>;
       /**
        * The max number of vaults that can be created
        **/
@@ -675,10 +671,6 @@ declare module '@polkadot/api-base/types/consts' {
        * Minimum vault securitization required while the operational floor lock is active.
        **/
       operationalMinimumVaultSecuritization: u128 & AugmentedConst<ApiType>;
-      /**
-       * Number of Argon blocks to keep recent `available_for_lock` drops for stale init checks.
-       **/
-      recentCapacityDropBlockWindow: u32 & AugmentedConst<ApiType>;
       /**
        * The number of frames within which revenue must be collected
        **/

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

@@ -98,6 +98,18 @@ declare module '@polkadot/api-base/types/errors' {
        * An overflow occurred recording a lock expiration
        **/
       ExpirationAtBlockOverflow: AugmentedError<ApiType>;
+      /**
+       * The fee coupon nonce is not the next unconsumed nonce.
+       **/
+      FeeCouponAlreadyUsed: AugmentedError<ApiType>;
+      /**
+       * The fee coupon is past its expiration frame.
+       **/
+      FeeCouponExpired: AugmentedError<ApiType>;
+      /**
+       * Fee coupons can only be applied when initializing a lock.
+       **/
+      FeeCouponOnlyForInitialization: AugmentedError<ApiType>;
       /**
        * Cannot request an orphaned release for the funding UTXO
        **/
@@ -124,6 +136,10 @@ declare module '@polkadot/api-base/types/errors' {
        * The bitcoin script to lock this bitcoin has errors
        **/
       InvalidBitcoinScript: AugmentedError<ApiType>;
+      /**
+       * The fee coupon was not signed by the vault delegate.
+       **/
+      InvalidFeeCouponSignature: AugmentedError<ApiType>;
       /**
        * Funding would result in an overflow of the balance type
        **/
@@ -1012,6 +1028,11 @@ declare module '@polkadot/api-base/types/errors' {
        * One of the linked account ownership proofs is invalid.
        **/
       InvalidAccountProof: AugmentedError<ApiType>;
+      /**
+       * Profile names must start with an uppercase ASCII letter and otherwise be ASCII
+       * alphanumeric.
+       **/
+      InvalidName: AugmentedError<ApiType>;
       /**
        * The caller is not one of the accounts included in the registration.
        **/
@@ -1239,17 +1260,13 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       BondLotAlreadyReleasing: AugmentedError<ApiType>;
       /**
-       * Only an active vault bond owned by its operator can be used as backfill.
+       * Only an active vault bond owned by its operator can be used as flexible.
        **/
-      BondLotNotEligibleForBackfill: AugmentedError<ApiType>;
+      BondLotCannotBeFlexible: AugmentedError<ApiType>;
       /**
        * The bond lot could not be found.
        **/
       BondLotNotFound: AugmentedError<ApiType>;
-      /**
-       * The vault doesn't have enough bitcoin security to support this bond purchase
-       **/
-      BondPurchaseAboveSecurity: AugmentedError<ApiType>;
       /**
        * The purchase is below the minimum amount.
        **/
@@ -1259,9 +1276,13 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       BondPurchaseRejected: AugmentedError<ApiType>;
       /**
-       * The beneficiary already has a bond lot for this vault.
+       * The bonus approval nonce has already been consumed or superseded.
+       **/
+      BonusApprovalAlreadyUsed: AugmentedError<ApiType>;
+      /**
+       * The approved bonus plus the vault's profit sharing exceeds 100%.
        **/
-      BonusApprovalExistingBondLot: AugmentedError<ApiType>;
+      BonusApprovalExceedsProfitSharing: AugmentedError<ApiType>;
       /**
        * The bonus approval already expired.
        **/
@@ -1274,6 +1295,10 @@ declare module '@polkadot/api-base/types/errors' {
        * The bonus approval was signed for a different vault.
        **/
       BonusApprovalWrongVault: AugmentedError<ApiType>;
+      /**
+       * The vault doesn't have enough bitcoin security to support this bond purchase
+       **/
+      InsufficientBondSpace: AugmentedError<ApiType>;
       /**
        * An internal error occurred.
        **/
@@ -1362,10 +1387,6 @@ declare module '@polkadot/api-base/types/errors' {
        * The bitcoin script to lock this bitcoin has errors
        **/
       InvalidBitcoinScript: AugmentedError<ApiType>;
-      /**
-       * Treasury bond sharing plus bonus cannot exceed 100%.
-       **/
-      InvalidBondSharingTerms: AugmentedError<ApiType>;
       /**
        * An invalid securitization percent was provided for the vault. NOTE: it cannot be
        * decreased (or negative)
@@ -1375,11 +1396,6 @@ declare module '@polkadot/api-base/types/errors' {
        * Funding would result in an overflow of the balance type
        **/
       InvalidVaultAmount: AugmentedError<ApiType>;
-      /**
-       * Vault names must start with an uppercase ASCII letter and otherwise be ASCII
-       * alphanumeric.
-       **/
-      InvalidVaultName: AugmentedError<ApiType>;
       /**
        * Unable to decode xpubkey
        **/

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

@@ -317,11 +317,6 @@ declare module '@polkadot/api-base/types/events' {
         [utxoId: u64, vaultId: u32, compensationAmount: u128, compensatedAccountId: AccountId32],
         { utxoId: u64; vaultId: u32; compensationAmount: u128; compensatedAccountId: AccountId32 }
       >;
-      BitcoinLockBackfillChanged: AugmentedEvent<
-        ApiType,
-        [utxoId: u64, vaultId: u32, isBackfill: bool],
-        { utxoId: u64; vaultId: u32; isBackfill: bool }
-      >;
       BitcoinLockBurned: AugmentedEvent<
         ApiType,
         [utxoId: u64, vaultId: u32, wasUtxoSpent: bool],
@@ -348,6 +343,11 @@ declare module '@polkadot/api-base/types/events' {
           securityFee: u128;
         }
       >;
+      BitcoinLockFlexibleChanged: AugmentedEvent<
+        ApiType,
+        [utxoId: u64, vaultId: u32, isFlexible: bool],
+        { utxoId: u64; vaultId: u32; isFlexible: bool }
+      >;
       BitcoinLockRatcheted: AugmentedEvent<
         ApiType,
         [
@@ -1847,15 +1847,10 @@ declare module '@polkadot/api-base/types/events' {
       >;
     };
     treasury: {
-      BackfillBondsReservedChanged: AugmentedEvent<
-        ApiType,
-        [vaultId: u32, backfillBondsReserved: u32],
-        { vaultId: u32; backfillBondsReserved: u32 }
-      >;
-      BondLotBackfillChanged: AugmentedEvent<
+      BondLotFlexibilityChanged: AugmentedEvent<
         ApiType,
-        [vaultId: u32, bondLotId: u64, isBackfill: bool],
-        { vaultId: u32; bondLotId: u64; isBackfill: bool }
+        [vaultId: u32, bondLotId: u64, isFlexible: bool],
+        { vaultId: u32; bondLotId: u64; isFlexible: bool }
       >;
       /**
        * A bond purchase entered its active program set.
@@ -2030,6 +2025,11 @@ declare module '@polkadot/api-base/types/events' {
         [frameId: u64, totalEligibleBonds: u128, participatingVaults: u32],
         { frameId: u64; totalEligibleBonds: u128; participatingVaults: u32 }
       >;
+      ReservedBondSpaceChanged: AugmentedEvent<
+        ApiType,
+        [vaultId: u32, reservedBondSpace: u32],
+        { vaultId: u32; reservedBondSpace: u32 }
+      >;
     };
     txPause: {
       /**
@@ -2101,11 +2101,6 @@ declare module '@polkadot/api-base/types/events' {
       >;
     };
     vaults: {
-      BackfillSecuritizationReservedChanged: AugmentedEvent<
-        ApiType,
-        [vaultId: u32, backfillSecuritizationReserved: u128],
-        { vaultId: u32; backfillSecuritizationReserved: u128 }
-      >;
       CommittedArgonotsSet: AugmentedEvent<
         ApiType,
         [vaultId: u32, operatorAccountId: AccountId32, amount: u128],
@@ -2155,6 +2150,11 @@ declare module '@polkadot/api-base/types/events' {
         [vaultId: u32, beneficiary: AccountId32, toBeneficiary: u128, burned: u128],
         { vaultId: u32; beneficiary: AccountId32; toBeneficiary: u128; burned: u128 }
       >;
+      ReservedSecuritizationSpaceChanged: AugmentedEvent<
+        ApiType,
+        [vaultId: u32, reservedSecuritizationSpace: u128],
+        { vaultId: u32; reservedSecuritizationSpace: u128 }
+      >;
       TreasuryRecordingError: AugmentedEvent<
         ApiType,
         [vaultId: u32, frameId: u64, vaultEarnings: u128, error: SpRuntimeDispatchError],

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

@@ -109,7 +109,6 @@ import type {
   PalletTreasuryFrameArgonotBondParticipants,
   PalletTreasuryFrameVaultCapital,
   PalletTreasuryVaultBondState,
-  PalletVaultsRecentCapacityDrop,
   PalletVaultsVaultFrameRevenue,
   SpConsensusGrandpaAppPublic,
   SpRuntimeDigest,
@@ -211,6 +210,14 @@ declare module '@polkadot/api-base/types/storage' {
       totalIssuance: AugmentedQuery<ApiType, () => Observable<u128>, []>;
     };
     bitcoinLocks: {
+      lastFeeCouponNonceByVaultAndAccount: AugmentedQuery<
+        ApiType,
+        (
+          arg1: u32 | AnyNumber | Uint8Array,
+          arg2: AccountId32 | string | Uint8Array,
+        ) => Observable<Option<u64>>,
+        [u32, AccountId32]
+      >;
       /**
        * Utxos that have been requested to be cosigned for releasing
        **/
@@ -343,7 +350,8 @@ declare module '@polkadot/api-base/types/storage' {
         []
       >;
       /**
-       * Pending funding entries that have expired and are awaiting bounded cleanup.
+       * Pending funding entries that have expired. These remain watched until their additional
+       * orphan-detection window ends, then await bounded cleanup.
        **/
       expiredPendingFunding: AugmentedQuery<
         ApiType,
@@ -1310,6 +1318,19 @@ declare module '@polkadot/api-base/types/storage' {
       >;
     };
     operationalAccounts: {
+      /**
+       * Set of operational accounts that have met both follow-on access-code thresholds.
+       * The key count weights frame processing without scanning the set twice.
+       **/
+      accessCodeReadyAccounts: AugmentedQuery<
+        ApiType,
+        (arg: AccountId32 | string | Uint8Array) => Observable<Option<Null>>,
+        [AccountId32]
+      >;
+      /**
+       * Counter for the related counted storage map
+       **/
+      counterForAccessCodeReadyAccounts: AugmentedQuery<ApiType, () => Observable<u32>, []>;
       /**
        * Whether operational-account access is invite-only.
        *
@@ -1435,7 +1456,7 @@ declare module '@polkadot/api-base/types/storage' {
        **/
       current: AugmentedQuery<ApiType, () => Observable<Option<PalletPriceIndexPriceIndex>>, []>;
       /**
-       * Stores Ethereum pricing submitted with the active price index.
+       * Stores the latest submitted Ethereum pricing.
        **/
       currentEthereumPrice: AugmentedQuery<
         ApiType,
@@ -1737,7 +1758,7 @@ declare module '@polkadot/api-base/types/storage' {
        * 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. Backfill lots remain in `BondLotById` and are represented here by their
+       * when amounts tie. Flexible lots remain in `BondLotById` and are represented here by their
        * aggregate.
        **/
       bondLotsByVault: AugmentedQuery<
@@ -1778,6 +1799,14 @@ declare module '@polkadot/api-base/types/storage' {
         (arg: AccountId32 | string | Uint8Array) => Observable<u128>,
         [AccountId32]
       >;
+      lastBonusApprovalNonceByVaultAndAccount: AugmentedQuery<
+        ApiType,
+        (
+          arg1: u32 | AnyNumber | Uint8Array,
+          arg2: AccountId32 | string | Uint8Array,
+        ) => Observable<Option<u64>>,
+        [u32, AccountId32]
+      >;
       /**
        * The next bond lot id.
        **/
@@ -1859,14 +1888,6 @@ declare module '@polkadot/api-base/types/storage' {
         (arg: u64 | AnyNumber | Uint8Array) => Observable<Vec<u32>>,
         [u64]
       >;
-      /**
-       * Recent reductions in `available_for_lock`, grouped by vault.
-       **/
-      recentCapacityDropsByVault: AugmentedQuery<
-        ApiType,
-        (arg: u32 | AnyNumber | Uint8Array) => Observable<Vec<PalletVaultsRecentCapacityDrop>>,
-        [u32]
-      >;
       /**
        * Tracks revenue from Bitcoin Locks and Treasury Pools for the trailing frames for each vault
        * (a frame is a "mining day" in Argon). Newest frames are first. Frames are removed after the

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

@@ -348,6 +348,7 @@ declare module '@polkadot/api-base/types/submittable' {
             | Uint8Array
             | PalletBitcoinLocksLockOptions
             | { V1: any }
+            | { V2: any }
             | string,
         ) => SubmittableExtrinsic<ApiType>,
         [
@@ -357,30 +358,6 @@ declare module '@polkadot/api-base/types/submittable' {
           Option<PalletBitcoinLocksLockOptions>,
         ]
       >;
-      initializeFor: AugmentedSubmittable<
-        (
-          accountId: AccountId32 | string | Uint8Array,
-          vaultId: u32 | AnyNumber | Uint8Array,
-          satoshis: Compact<u64> | AnyNumber | Uint8Array,
-          bitcoinPubkey: ArgonPrimitivesBitcoinCompressedBitcoinPubkey | string | Uint8Array,
-          options:
-            | Option<PalletBitcoinLocksLockOptions>
-            | null
-            | Uint8Array
-            | PalletBitcoinLocksLockOptions
-            | { V1: any }
-            | string,
-          backfillSecuritizationToUnreserve: Compact<u128> | AnyNumber | Uint8Array,
-        ) => SubmittableExtrinsic<ApiType>,
-        [
-          AccountId32,
-          u32,
-          Compact<u64>,
-          ArgonPrimitivesBitcoinCompressedBitcoinPubkey,
-          Option<PalletBitcoinLocksLockOptions>,
-          Compact<u128>,
-        ]
-      >;
       /**
        * 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
@@ -406,6 +383,7 @@ declare module '@polkadot/api-base/types/submittable' {
             | Uint8Array
             | PalletBitcoinLocksLockOptions
             | { V1: any }
+            | { V2: any }
             | string,
         ) => SubmittableExtrinsic<ApiType>,
         [u64, Option<PalletBitcoinLocksLockOptions>]
@@ -438,10 +416,10 @@ declare module '@polkadot/api-base/types/submittable' {
         ) => SubmittableExtrinsic<ApiType>,
         [u64, Bytes, u64]
       >;
-      setAsBackfill: AugmentedSubmittable<
+      setFlexible: AugmentedSubmittable<
         (
           utxoId: u64 | AnyNumber | Uint8Array,
-          isBackfill: bool | boolean | Uint8Array,
+          isFlexible: bool | boolean | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
         [u64, bool]
       >;
@@ -1219,6 +1197,13 @@ declare module '@polkadot/api-base/types/submittable' {
         ) => SubmittableExtrinsic<ApiType>,
         [PalletOperationalAccountsRegistration]
       >;
+      /**
+       * Update the display name on an operational account profile from any linked account.
+       **/
+      setName: AugmentedSubmittable<
+        (name: Option<Bytes> | null | Uint8Array | Bytes | string) => SubmittableExtrinsic<ApiType>,
+        [Option<Bytes>]
+      >;
       /**
        * Update certification reward amounts for operational accounts.
        **/
@@ -2065,8 +2050,10 @@ declare module '@polkadot/api-base/types/submittable' {
             | {
                 vaultId?: any;
                 beneficiary?: any;
+                bonusPercent?: any;
                 expiresAtFrame?: any;
-                backfillBondsToUnreserve?: any;
+                bondSpaceToUnreserve?: any;
+                nonce?: any;
                 signature?: any;
               }
             | string,
@@ -2082,19 +2069,22 @@ declare module '@polkadot/api-base/types/submittable' {
         (bondLotId: u64 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
         [u64]
       >;
-      setBackfillBondsReserved: AugmentedSubmittable<
+      setBondLotFlexible: AugmentedSubmittable<
         (
-          vaultId: u32 | AnyNumber | Uint8Array,
-          backfillBondsReserved: u32 | AnyNumber | Uint8Array,
+          bondLotId: u64 | AnyNumber | Uint8Array,
+          isFlexible: bool | boolean | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
-        [u32, u32]
+        [u64, bool]
       >;
-      setBondLotAsBackfill: AugmentedSubmittable<
+      /**
+       * Reserve vault bond space for future bond purchases.
+       **/
+      setReservedBondSpace: AugmentedSubmittable<
         (
-          bondLotId: u64 | AnyNumber | Uint8Array,
-          isBackfill: bool | boolean | Uint8Array,
+          vaultId: u32 | AnyNumber | Uint8Array,
+          reservedBondSpace: u32 | AnyNumber | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
-        [u64, bool]
+        [u32, u32]
       >;
     };
     txPause: {
@@ -2318,7 +2308,6 @@ declare module '@polkadot/api-base/types/submittable' {
             | PalletVaultsVaultConfig
             | {
                 terms?: any;
-                name?: any;
                 delegateAccountId?: any;
                 securitization?: any;
                 bitcoinXpubkey?: any;
@@ -2356,12 +2345,7 @@ declare module '@polkadot/api-base/types/submittable' {
           vaultId: u32 | AnyNumber | Uint8Array,
           terms:
             | ArgonPrimitivesVaultVaultTerms
-            | {
-                bitcoinAnnualPercentRate?: any;
-                bitcoinBaseFee?: any;
-                treasuryProfitSharing?: any;
-                treasuryBonusProfitSharing?: any;
-              }
+            | { bitcoinAnnualPercentRate?: any; bitcoinBaseFee?: any; treasuryProfitSharing?: any }
             | string
             | Uint8Array,
         ) => SubmittableExtrinsic<ApiType>,
@@ -2379,13 +2363,6 @@ declare module '@polkadot/api-base/types/submittable' {
         ) => SubmittableExtrinsic<ApiType>,
         [u32, ArgonPrimitivesBitcoinOpaqueBitcoinXpub]
       >;
-      setBackfillSecuritizationReserved: AugmentedSubmittable<
-        (
-          vaultId: u32 | AnyNumber | Uint8Array,
-          backfillSecuritizationReserved: u128 | AnyNumber | Uint8Array,
-        ) => SubmittableExtrinsic<ApiType>,
-        [u32, u128]
-      >;
       setCommittedArgonots: AugmentedSubmittable<
         (amount: Compact<u128> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
         [Compact<u128>]
@@ -2396,9 +2373,14 @@ declare module '@polkadot/api-base/types/submittable' {
         ) => SubmittableExtrinsic<ApiType>,
         [Option<AccountId32>]
       >;
-      setName: AugmentedSubmittable<
-        (name: Option<Bytes> | null | Uint8Array | Bytes | string) => SubmittableExtrinsic<ApiType>,
-        [Option<Bytes>]
+      /**
+       * Reserve vault securitization space for future Bitcoin locks.
+       **/
+      setReservedSecuritizationSpace: AugmentedSubmittable<
+        (
+          reservedSecuritizationSpace: u128 | AnyNumber | Uint8Array,
+        ) => SubmittableExtrinsic<ApiType>,
+        [u128]
       >;
     };
   } // AugmentedSubmittables