@argonprotocol/mainchain 1.4.12 → 1.4.13-dev.5fb39621

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/mainchain",
-  "version": "1.4.12",
+  "version": "1.4.13-dev.5fb39621",
   "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"
   },
@@ -52,31 +53,32 @@
   "dependencies": {
     "@ethereumjs/block": "^10.1.1",
     "@ethereumjs/mpt": "^10.1.1",
-    "@polkadot/api": "^16.5.6",
-    "@polkadot/api-base": "^16.5.6",
+    "@polkadot/api": "^17.0.1",
+    "@polkadot/api-base": "^17.0.1",
     "@polkadot/keyring": "^14.0.3",
-    "@polkadot/rpc-core": "^16.5.6",
-    "@polkadot/rpc-provider": "^16.5.6",
-    "@polkadot/types": "^16.5.6",
-    "@polkadot/types-codec": "^16.5.6",
+    "@polkadot/rpc-core": "^17.0.1",
+    "@polkadot/rpc-provider": "^17.0.1",
+    "@polkadot/types": "^17.0.1",
+    "@polkadot/types-codec": "^17.0.1",
     "@polkadot/util": "^14.0.3",
     "@polkadot/util-crypto": "^14.0.3",
     "bignumber.js": "^9.3.1",
-    "bs58check": "^4.0.0",
     "camelcase-keys": "^9.1.3",
     "viem": "^2.38.5"
   },
   "devDependencies": {
     "@argonprotocol/ethereum-contracts": "workspace:*",
-    "@argonprotocol/testing": "1.4.12",
-    "@polkadot/typegen": "^16.5.6",
+    "@argonprotocol/testing": "1.4.13-dev.5fb39621",
+    "@polkadot/typegen": "^17.0.1",
     "@substrate/ss58-registry": "^1.51.0",
     "@types/node": "^20",
+    "@types/ws": "^8.18.1",
     "shx": "^0.4.0",
     "tsup": "^8.5.0",
     "tsx": "^4.20.4",
     "typescript": "^5.9.2",
-    "vitest": "^4.0.5"
+    "vitest": "^5.0.0",
+    "ws": "^8.18.0"
   },
   "packageManager": "yarn@4.1.0"
 }

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

@@ -1,9 +1,8 @@
 // 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
-import type {} from '@polkadot/api-base/types/consts';
+import '@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';
@@ -51,6 +50,16 @@ declare module '@polkadot/api-base/types/consts' {
        **/
       maxReserves: u32 & AugmentedConst<ApiType>;
     };
+    bitcoinFissions: {
+      /**
+       * Maximum number of active Fissions that may allocate satoshis from one Lock.
+       **/
+      maxFissionsPerLock: u32 & AugmentedConst<ApiType>;
+      /**
+       * Minimum percentage change required to ratchet a Fission.
+       **/
+      minimumRatchetPercent: Percent & AugmentedConst<ApiType>;
+    };
     bitcoinLocks: {
       /**
        * Argon tick per day
@@ -82,11 +91,19 @@ declare module '@polkadot/api-base/types/consts' {
        * Maximum releasing utxos at a time
        **/
       maxConcurrentlyReleasingLocks: u32 & AugmentedConst<ApiType>;
+      /**
+       * Maximum number of confirmed Bitcoin outputs that may fund one Lock.
+       **/
+      maxUtxosPerLock: u32 & AugmentedConst<ApiType>;
       /**
        * Number of frames orphaned UTXO release entries are retained after a lock lifecycle
        * transition before being cleaned up.
        **/
       orphanedUtxoReleaseExpiryFrames: u64 & AugmentedConst<ApiType>;
+      /**
+       * Number of Bitcoin blocks to reserve securitization that has not yet been activated.
+       **/
+      securitizationHoldBlocks: u64 & AugmentedConst<ApiType>;
       /**
        * Number of ticks per bitcoin block
        **/
@@ -94,27 +111,9 @@ declare module '@polkadot/api-base/types/consts' {
     };
     bitcoinUtxos: {
       /**
-       * Maximum number of candidate UTXOs stored per lock
+       * Maximum number of outputs tracked for a single Lock address.
        **/
-      maxCandidateUtxosPerLock: u32 & AugmentedConst<ApiType>;
-      /**
-       * Maximum number of satoshi difference allowed from expected to consider a UTXO as
-       * "confirmed"
-       **/
-      maximumSatoshiThresholdFromExpected: u64 & AugmentedConst<ApiType>;
-      /**
-       * 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>;
-      /**
-       * The maximum number of UTXOs that can be watched in a block and/or expiring at same block
-       **/
-      maxPendingConfirmationUtxos: u32 & AugmentedConst<ApiType>;
-      /**
-       * The maximum number of expired pending funding entries cleaned up in a block
-       **/
-      maxPendingFundingExpirationsPerBlock: u32 & AugmentedConst<ApiType>;
+      maxUtxosPerLock: u32 & AugmentedConst<ApiType>;
     };
     blockRewards: {
       /**
@@ -591,10 +590,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 +610,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 +623,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.
        **/
-      percentForArgonotBondPool: Percent & AugmentedConst<ApiType>;
+      percentForMiningOperatorPool: Percent & AugmentedConst<ApiType>;
+      /**
+       * Percent of the full bid pool paid to Argonot Stakes.
+       **/
+      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.
        **/
@@ -664,17 +683,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

@@ -3,7 +3,7 @@
 
 // import type lookup before we augment - in some environments
 // this is required to allow for ambient/previous definitions
-import type {} from '@polkadot/api-base/types/errors';
+import '@polkadot/api-base/types/errors';
 
 import type { ApiTypes, AugmentedError } from '@polkadot/api-base/types';
 
@@ -61,6 +61,88 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       VestingBalance: AugmentedError<ApiType>;
     };
+    bitcoinFissions: {
+      /**
+       * A Fission already exists under this owner and Fission ID.
+       **/
+      FissionAlreadyExists: AugmentedError<ApiType>;
+      /**
+       * A Fission must allocate at least one satoshi.
+       **/
+      FissionHasNoSatoshis: AugmentedError<ApiType>;
+      /**
+       * The submitted Fission ID is below the owner's current minimum.
+       **/
+      FissionIdBelowMinimum: AugmentedError<ApiType>;
+      /**
+       * The owner's Fission ID counter cannot be incremented.
+       **/
+      FissionIdOverflow: AugmentedError<ApiType>;
+      /**
+       * No Fission exists under this owner and Fission ID.
+       **/
+      FissionNotFound: AugmentedError<ApiType>;
+      /**
+       * The requested target-normalized BTC value is not present in recent price history.
+       **/
+      IneligibleMicrogonsAtTargetPerBtc: AugmentedError<ApiType>;
+      /**
+       * A source Lock has fewer active Fission satoshis than the Fission being closed.
+       **/
+      InsufficientFissionedSatoshis: AugmentedError<ApiType>;
+      /**
+       * A requested source Lock does not have enough unallocated funded satoshis.
+       **/
+      InsufficientFundedSatoshis: AugmentedError<ApiType>;
+      /**
+       * The Fission owner cannot burn the complete redemption amount.
+       **/
+      InsufficientFunds: AugmentedError<ApiType>;
+      /**
+       * A source Lock's securitization does not cover the requested allocation and liability.
+       **/
+      InsufficientSecuritization: AugmentedError<ApiType>;
+      /**
+       * The requested source Lock does not exist.
+       **/
+      LockNotFound: AugmentedError<ApiType>;
+      /**
+       * A requested source Lock has no confirmed funding satoshis.
+       **/
+      LockNotFunded: AugmentedError<ApiType>;
+      /**
+       * A requested source Lock is already in the release process.
+       **/
+      LockReleasePending: AugmentedError<ApiType>;
+      /**
+       * The requested price-history entry predates the Fission or Lock coverage floor.
+       **/
+      MicrogonsAtTargetPerBtcTickOlderThanCurrent: AugmentedError<ApiType>;
+      /**
+       * No current Bitcoin price is available to calculate the redemption amount.
+       **/
+      NoBitcoinPricesAvailable: AugmentedError<ApiType>;
+      /**
+       * The caller does not own a requested source Lock.
+       **/
+      NoPermissions: AugmentedError<ApiType>;
+      /**
+       * The Fission did not meet both the minimum change and Lock coverage requirements.
+       **/
+      NoRatchetingAvailable: AugmentedError<ApiType>;
+      /**
+       * A Fission allocation, liability, or identifier overflowed.
+       **/
+      Overflow: AugmentedError<ApiType>;
+      /**
+       * The Fission's ratchet counter cannot be incremented.
+       **/
+      RatchetNumberOverflow: AugmentedError<ApiType>;
+      /**
+       * The source Lock already has the maximum number of active Fissions.
+       **/
+      TooManyFissionsForLock: AugmentedError<ApiType>;
+    };
     bitcoinLocks: {
       /**
        * The proposed transaction would take the account below the minimum (existential) balance
@@ -78,6 +160,14 @@ declare module '@polkadot/api-base/types/errors' {
        * This bitcoin pubkey couldn't be decoded for release
        **/
       BitcoinPubkeyUnableToBeDecoded: AugmentedError<ApiType>;
+      /**
+       * A configured or requested Lock amount is below the required minimum.
+       **/
+      BitcoinReleaseChangeBelowMinimum: AugmentedError<ApiType>;
+      /**
+       * The release destination cannot be the Lock's own script.
+       **/
+      BitcoinReleaseDestinationIsLockScript: AugmentedError<ApiType>;
       /**
        * The bitcoin has passed the deadline to release it
        **/
@@ -107,9 +197,9 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       FeeCouponExpired: AugmentedError<ApiType>;
       /**
-       * Fee coupons can only be applied when initializing a lock.
+       * The Lock records fissioned satoshis without matching active Fission requirements.
        **/
-      FeeCouponOnlyForInitialization: AugmentedError<ApiType>;
+      FissionStateMismatch: AugmentedError<ApiType>;
       /**
        * Cannot request an orphaned release for the funding UTXO
        **/
@@ -123,15 +213,23 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       HoldUnexpectedlyModified: AugmentedError<ApiType>;
       /**
-       * An ineligible microgon rate per btc was requested
+       * The requested target-normalized BTC value is not present in recent price history.
        **/
-      IneligibleMicrogonRateRequested: AugmentedError<ApiType>;
+      IneligibleMicrogonsAtTargetPerBtcRequested: AugmentedError<ApiType>;
       InsufficientFunds: AugmentedError<ApiType>;
       /**
-       * The minimum number of satoshis was not met
+       * The requested Lock securitization has fewer satoshis than its active Fissions.
        **/
-      InsufficientSatoshisLocked: AugmentedError<ApiType>;
+      InsufficientSatoshisForFissions: AugmentedError<ApiType>;
+      /**
+       * The requested Lock securitization does not cover its active Fission liabilities.
+       **/
+      InsufficientSecuritizationForFissions: AugmentedError<ApiType>;
       InsufficientVaultFunds: AugmentedError<ApiType>;
+      /**
+       * The external destination amount must be nonzero and fit with the network fee.
+       **/
+      InvalidBitcoinReleaseAmount: AugmentedError<ApiType>;
       /**
        * The bitcoin script to lock this bitcoin has errors
        **/
@@ -145,7 +243,11 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       InvalidVaultAmount: AugmentedError<ApiType>;
       /**
-       * A lock in process of release cannot be ratcheted
+       * The Lock cannot be released while it has active Fissions.
+       **/
+      LockHasActiveFissions: AugmentedError<ApiType>;
+      /**
+       * A Lock in the release process cannot be resecuritized.
        **/
       LockInProcessOfRelease: AugmentedError<ApiType>;
       /**
@@ -155,11 +257,23 @@ declare module '@polkadot/api-base/types/errors' {
       /**
        * The lock funding has not been confirmed on bitcoin
        **/
-      LockPendingFunding: AugmentedError<ApiType>;
+      LockNotFunded: AugmentedError<ApiType>;
       /**
        * Too many orphaned utxo release requests for a lock
        **/
       MaxOrphanedUtxoReleaseRequestsExceeded: AugmentedError<ApiType>;
+      /**
+       * Too many confirmed Bitcoin outputs were assigned to one Lock.
+       **/
+      MaxUtxosPerLockExceeded: AugmentedError<ApiType>;
+      /**
+       * The requested price-history entry predates the Lock's current securitization.
+       **/
+      MicrogonsAtTargetPerBtcTickOlderThanCurrent: AugmentedError<ApiType>;
+      /**
+       * The minimum cannot increase while a release is pending.
+       **/
+      MinimumSatoshisIncreaseBlockedByPendingRelease: AugmentedError<ApiType>;
       /**
        * The price provider has no bitcoin prices available. This is a temporary error
        **/
@@ -169,9 +283,9 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       NoPermissions: AugmentedError<ApiType>;
       /**
-       * Nothing to ratchet
+       * The requested securitization matches the Lock's current securitization.
        **/
-      NoRatchetingAvailable: AugmentedError<ApiType>;
+      NoResecuritizationChange: AugmentedError<ApiType>;
       /**
        * No Vault public keys are available
        **/
@@ -219,9 +333,9 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       BitcoinHeightNotConfirmed: AugmentedError<ApiType>;
       /**
-       * Duplicated UtxoId. Already in use
+       * Duplicated BitcoinLockId. Already in use
        **/
-      DuplicateUtxoId: AugmentedError<ApiType>;
+      DuplicateLockId: AugmentedError<ApiType>;
       /**
        * Insufficient bitcoin amount
        **/
@@ -234,14 +348,6 @@ declare module '@polkadot/api-base/types/errors' {
        * Invalid bitcoin sync height attempted
        **/
       InvalidBitcoinSyncHeight: AugmentedError<ApiType>;
-      /**
-       * This Lock already has an attached funding UTXO
-       **/
-      LockAlreadyFunded: AugmentedError<ApiType>;
-      /**
-       * Too many candidate UTXOs are being stored for this lock
-       **/
-      MaxCandidateUtxosExceeded: AugmentedError<ApiType>;
       /**
        * Too many UTXOs are being watched
        **/
@@ -267,11 +373,7 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       ScriptPubkeyConflict: AugmentedError<ApiType>;
       /**
-       * The UTXO reference does not map to a candidate entry
-       **/
-      UtxoNotCandidate: AugmentedError<ApiType>;
-      /**
-       * Locked Utxo Not Found
+       * Watched Lock or attached UTXO not found.
        **/
       UtxoNotLocked: AugmentedError<ApiType>;
     };
@@ -1259,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.
        **/
@@ -1279,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.
        **/
@@ -1296,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.
        **/
@@ -1359,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
        **/