@argonprotocol/mainchain 1.4.11 → 1.4.12-dev.2bc449e2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/mainchain",
-  "version": "1.4.11",
+  "version": "1.4.12-dev.2bc449e2",
   "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": [
@@ -59,13 +62,12 @@
     "@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.11",
+    "@argonprotocol/testing": "1.4.12-dev.2bc449e2",
     "@polkadot/typegen": "^16.5.6",
     "@substrate/ss58-registry": "^1.51.0",
     "@types/node": "^20",
@@ -73,7 +75,7 @@
     "tsup": "^8.5.0",
     "tsx": "^4.20.4",
     "typescript": "^5.9.2",
-    "vitest": "^4.0.5"
+    "vitest": "^5.0.0"
   },
   "packageManager": "yarn@4.1.0"
 }

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
@@ -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,26 +111,9 @@ declare module '@polkadot/api-base/types/consts' {
     };
     bitcoinUtxos: {
       /**
-       * Maximum number of candidate UTXOs stored per lock
-       **/
-      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 watch a Utxo for confirmation before canceling
+       * Maximum number of outputs tracked for a single Lock address.
        **/
-      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: {
       /**
@@ -375,6 +375,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 +650,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 +658,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 +670,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

@@ -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 partial release would leave less than the minimum watched Lock amount.
+       **/
+      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
        **/
@@ -98,6 +188,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>;
+      /**
+       * The Lock records fissioned satoshis without matching active Fission requirements.
+       **/
+      FissionStateMismatch: AugmentedError<ApiType>;
       /**
        * Cannot request an orphaned release for the funding UTXO
        **/
@@ -111,25 +213,41 @@ 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
        **/
       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
        **/
       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>;
       /**
@@ -139,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
        **/
@@ -153,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
        **/
@@ -203,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
        **/
@@ -218,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
        **/
@@ -251,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>;
     };
@@ -1012,6 +1130,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 +1362,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 +1378,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 +1397,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 +1489,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 +1498,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
        **/