@argonprotocol/mainchain 1.4.11-dev.f3bdc948 → 1.4.12-dev.2afa6e4a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/mainchain",
-  "version": "1.4.11-dev.f3bdc948",
+  "version": "1.4.12-dev.2afa6e4a",
   "description": "A client for accessing the Argon mainchain apis.",
   "repository": {
     "type": "git",
@@ -62,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-dev.f3bdc948",
+    "@argonprotocol/testing": "1.4.12-dev.2afa6e4a",
     "@polkadot/typegen": "^16.5.6",
     "@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
@@ -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,6 +91,10 @@ declare module '@polkadot/api-base/types/consts' {
        * Maximum releasing utxos at a time
        **/
       maxConcurrentlyReleasingLocks: u32 & AugmentedConst<ApiType>;
+      /**
+       * Max bitcoin blocks up to which the first observed output may fund the Lock.
+       **/
+      maxPendingConfirmationBlocks: u64 & AugmentedConst<ApiType>;
       /**
        * Number of frames orphaned UTXO release entries are retained after a lock lifecycle
        * transition before being cleaned up.
@@ -94,27 +107,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 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
+       * Maximum number of outputs tracked for a single Lock address.
        **/
-      maxPendingFundingExpirationsPerBlock: u32 & AugmentedConst<ApiType>;
+      maxUtxosPerLock: u32 & AugmentedConst<ApiType>;
     };
     blockRewards: {
       /**

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
@@ -107,9 +189,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,14 +205,18 @@ 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 bitcoin script to lock this bitcoin has errors
@@ -145,7 +231,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>;
       /**
@@ -160,6 +250,10 @@ declare module '@polkadot/api-base/types/errors' {
        * Too many orphaned utxo release requests for a lock
        **/
       MaxOrphanedUtxoReleaseRequestsExceeded: AugmentedError<ApiType>;
+      /**
+       * The requested price-history entry predates the Lock's current securitization.
+       **/
+      MicrogonsAtTargetPerBtcTickOlderThanCurrent: AugmentedError<ApiType>;
       /**
        * The price provider has no bitcoin prices available. This is a temporary error
        **/
@@ -169,9 +263,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
        **/
@@ -234,18 +328,14 @@ 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
        **/
       MaxUtxosExceeded: AugmentedError<ApiType>;
+      /**
+       * Too many outputs have been observed at one Lock address.
+       **/
+      MaxUtxosPerLockExceeded: AugmentedError<ApiType>;
       /**
        * No Oracle-provided bitcoin block has been provided to the network
        **/
@@ -267,11 +357,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>;
     };

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

@@ -24,7 +24,6 @@ import type { ITuple } from '@polkadot/types-codec/types';
 import type { AccountId32, H160, H256 } from '@polkadot/types/interfaces/runtime';
 import type {
   ArgonNotaryAuditErrorVerifyError,
-  ArgonPrimitivesBitcoinBitcoinRejectedReason,
   ArgonPrimitivesBitcoinUtxoRef,
   ArgonPrimitivesBlockSealBlockPayout,
   ArgonPrimitivesBlockSealMiningRegistration,
@@ -311,6 +310,72 @@ declare module '@polkadot/api-base/types/events' {
         { who: AccountId32; amount: u128 }
       >;
     };
+    bitcoinFissions: {
+      /**
+       * A Fission was closed and its source Lock allocation was released.
+       **/
+      FissionClosed: AugmentedEvent<
+        ApiType,
+        [accountId: AccountId32, fissionId: u64, redemptionAmount: u128],
+        { accountId: AccountId32; fissionId: u64; redemptionAmount: u128 }
+      >;
+      /**
+       * An active Fission was closed because its source Lock was spent.
+       **/
+      FissionClosedByLock: AugmentedEvent<
+        ApiType,
+        [accountId: AccountId32, fissionId: u64, utxoId: u64],
+        { accountId: AccountId32; fissionId: u64; utxoId: u64 }
+      >;
+      /**
+       * A Fission was created and allocated from its source Lock.
+       **/
+      FissionCreated: AugmentedEvent<
+        ApiType,
+        [
+          accountId: AccountId32,
+          fissionId: u64,
+          liquidId: u64,
+          utxoId: u64,
+          satoshis: u64,
+          microgonsAtTargetPerBtc: u128,
+          liquidityPromised: u128,
+        ],
+        {
+          accountId: AccountId32;
+          fissionId: u64;
+          liquidId: u64;
+          utxoId: u64;
+          satoshis: u64;
+          microgonsAtTargetPerBtc: u128;
+          liquidityPromised: u128;
+        }
+      >;
+      /**
+       * A Fission ratchet changed its target-normalized BTC value and liability.
+       **/
+      FissionRatcheted: AugmentedEvent<
+        ApiType,
+        [
+          accountId: AccountId32,
+          fissionId: u64,
+          ratchetNumber: u32,
+          microgonsAtTargetPerBtc: u128,
+          liquidityPromised: u128,
+          amountMinted: u128,
+          amountBurned: u128,
+        ],
+        {
+          accountId: AccountId32;
+          fissionId: u64;
+          ratchetNumber: u32;
+          microgonsAtTargetPerBtc: u128;
+          liquidityPromised: u128;
+          amountMinted: u128;
+          amountBurned: u128;
+        }
+      >;
+    };
     bitcoinLocks: {
       BitcoinCosignPastDue: AugmentedEvent<
         ApiType,
@@ -327,18 +392,18 @@ declare module '@polkadot/api-base/types/events' {
         [
           utxoId: u64,
           vaultId: u32,
-          liquidityPromised: u128,
-          securitization: u128,
-          lockedTargetPrice: u128,
+          securitizedSatoshis: u64,
+          microgonsAtTargetPerBtc: u128,
+          collateralRequired: u128,
           accountId: AccountId32,
           securityFee: u128,
         ],
         {
           utxoId: u64;
           vaultId: u32;
-          liquidityPromised: u128;
-          securitization: u128;
-          lockedTargetPrice: u128;
+          securitizedSatoshis: u64;
+          microgonsAtTargetPerBtc: u128;
+          collateralRequired: u128;
           accountId: AccountId32;
           securityFee: u128;
         }
@@ -348,26 +413,20 @@ declare module '@polkadot/api-base/types/events' {
         [utxoId: u64, vaultId: u32, isFlexible: bool],
         { utxoId: u64; vaultId: u32; isFlexible: bool }
       >;
-      BitcoinLockRatcheted: AugmentedEvent<
+      BitcoinLockResecuritized: AugmentedEvent<
         ApiType,
         [
           utxoId: u64,
           vaultId: u32,
-          liquidityPromised: u128,
-          oldTargetPrice: u128,
-          securityFee: u128,
-          newTargetPrice: u128,
-          amountBurned: u128,
+          securitizedSatoshis: u64,
+          microgonsAtTargetPerBtc: u128,
           accountId: AccountId32,
         ],
         {
           utxoId: u64;
           vaultId: u32;
-          liquidityPromised: u128;
-          oldTargetPrice: u128;
-          securityFee: u128;
-          newTargetPrice: u128;
-          amountBurned: u128;
+          securitizedSatoshis: u64;
+          microgonsAtTargetPerBtc: u128;
           accountId: AccountId32;
         }
       >;
@@ -402,6 +461,14 @@ declare module '@polkadot/api-base/types/events' {
         [utxoId: u64, error: SpRuntimeDispatchError],
         { utxoId: u64; error: SpRuntimeDispatchError }
       >;
+      /**
+       * Not all orphaned UTXOs for a retired Lock fit in the cleanup schedule.
+       **/
+      OrphanedUtxoCleanupScheduleOverflow: AugmentedEvent<
+        ApiType,
+        [accountId: AccountId32, utxoId: u64, expirationFrame: u64],
+        { accountId: AccountId32; utxoId: u64; expirationFrame: u64 }
+      >;
       OrphanedUtxoCosigned: AugmentedEvent<
         ApiType,
         [
@@ -419,27 +486,28 @@ declare module '@polkadot/api-base/types/events' {
           signature: Bytes;
         }
       >;
-      OrphanedUtxoReceived: AugmentedEvent<
-        ApiType,
-        [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, satoshis: u64],
-        { utxoId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; vaultId: u32; satoshis: u64 }
-      >;
-      OrphanedUtxoReleaseRequested: AugmentedEvent<
+      /**
+       * An orphaned UTXO expiration could not reconcile its pending Vault cosign state.
+       **/
+      OrphanedUtxoExpirationError: AugmentedEvent<
         ApiType,
-        [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, accountId: AccountId32],
+        [
+          accountId: AccountId32,
+          utxoRef: ArgonPrimitivesBitcoinUtxoRef,
+          error: SpRuntimeDispatchError,
+        ],
         {
-          utxoId: u64;
-          utxoRef: ArgonPrimitivesBitcoinUtxoRef;
-          vaultId: u32;
           accountId: AccountId32;
+          utxoRef: ArgonPrimitivesBitcoinUtxoRef;
+          error: SpRuntimeDispatchError;
         }
       >;
-      SecuritizationIncreased: AugmentedEvent<
+      OrphanedUtxoReceived: AugmentedEvent<
         ApiType,
-        [utxoId: u64, vaultId: u32, newSatoshis: u64, accountId: AccountId32],
-        { utxoId: u64; vaultId: u32; newSatoshis: u64; accountId: AccountId32 }
+        [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, satoshis: u64],
+        { utxoId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; vaultId: u32; satoshis: u64 }
       >;
-      UtxoFundedFromCandidate: AugmentedEvent<
+      OrphanedUtxoReleaseRequested: AugmentedEvent<
         ApiType,
         [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, accountId: AccountId32],
         {
@@ -451,30 +519,30 @@ declare module '@polkadot/api-base/types/events' {
       >;
     };
     bitcoinUtxos: {
-      UtxoRejected: AugmentedEvent<
+      UtxoDetected: AugmentedEvent<
         ApiType,
         [
           utxoId: u64,
           utxoRef: ArgonPrimitivesBitcoinUtxoRef,
-          rejectedReason: ArgonPrimitivesBitcoinBitcoinRejectedReason,
           satoshisReceived: u64,
+          bitcoinHeight: u64,
         ],
         {
           utxoId: u64;
           utxoRef: ArgonPrimitivesBitcoinUtxoRef;
-          rejectedReason: ArgonPrimitivesBitcoinBitcoinRejectedReason;
           satoshisReceived: u64;
+          bitcoinHeight: u64;
         }
       >;
-      UtxoRejectedError: AugmentedEvent<
+      UtxoDetectedError: AugmentedEvent<
         ApiType,
         [utxoId: u64, error: SpRuntimeDispatchError],
         { utxoId: u64; error: SpRuntimeDispatchError }
       >;
       UtxoSpent: AugmentedEvent<
         ApiType,
-        [utxoId: u64, blockHeight: u64],
-        { utxoId: u64; blockHeight: u64 }
+        [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, blockHeight: u64],
+        { utxoId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; blockHeight: u64 }
       >;
       UtxoSpentError: AugmentedEvent<
         ApiType,
@@ -482,16 +550,6 @@ declare module '@polkadot/api-base/types/events' {
         { utxoId: u64; error: SpRuntimeDispatchError }
       >;
       UtxoUnwatched: AugmentedEvent<ApiType, [utxoId: u64], { utxoId: u64 }>;
-      UtxoVerified: AugmentedEvent<
-        ApiType,
-        [utxoId: u64, satoshisReceived: u64],
-        { utxoId: u64; satoshisReceived: u64 }
-      >;
-      UtxoVerifiedError: AugmentedEvent<
-        ApiType,
-        [utxoId: u64, error: SpRuntimeDispatchError],
-        { utxoId: u64; error: SpRuntimeDispatchError }
-      >;
     };
     blockRewards: {
       RewardCreated: AugmentedEvent<
@@ -1104,8 +1162,8 @@ declare module '@polkadot/api-base/types/events' {
        **/
       BitcoinMint: AugmentedEvent<
         ApiType,
-        [accountId: AccountId32, utxoId: Option<u64>, amount: u128],
-        { accountId: AccountId32; utxoId: Option<u64>; amount: u128 }
+        [accountId: AccountId32, fissionId: u64, utxoId: Option<u64>, amount: u128],
+        { accountId: AccountId32; fissionId: u64; utxoId: Option<u64>; amount: u128 }
       >;
       /**
        * The amount of microgons minted for mining. NOTE: accounts below Existential Deposit
@@ -1125,6 +1183,7 @@ declare module '@polkadot/api-base/types/events' {
         [
           mintType: PalletMintMintType,
           accountId: AccountId32,
+          fissionId: Option<u64>,
           utxoId: Option<u64>,
           amount: u128,
           error: SpRuntimeDispatchError,
@@ -1132,6 +1191,7 @@ declare module '@polkadot/api-base/types/events' {
         {
           mintType: PalletMintMintType;
           accountId: AccountId32;
+          fissionId: Option<u64>;
           utxoId: Option<u64>;
           amount: u128;
           error: SpRuntimeDispatchError;
@@ -2106,30 +2166,6 @@ declare module '@polkadot/api-base/types/events' {
         [vaultId: u32, operatorAccountId: AccountId32, amount: u128],
         { vaultId: u32; operatorAccountId: AccountId32; amount: u128 }
       >;
-      FundLockCanceled: AugmentedEvent<
-        ApiType,
-        [vaultId: u32, amount: u128],
-        { vaultId: u32; amount: u128 }
-      >;
-      FundsLocked: AugmentedEvent<
-        ApiType,
-        [
-          vaultId: u32,
-          locker: AccountId32,
-          liquidityPromised: u128,
-          isRatchet: bool,
-          feeRevenue: u128,
-          didUseFeeCoupon: bool,
-        ],
-        {
-          vaultId: u32;
-          locker: AccountId32;
-          liquidityPromised: u128;
-          isRatchet: bool;
-          feeRevenue: u128;
-          didUseFeeCoupon: bool;
-        }
-      >;
       FundsReleased: AugmentedEvent<
         ApiType,
         [vaultId: u32, securitization: u128],
@@ -2155,6 +2191,28 @@ declare module '@polkadot/api-base/types/events' {
         [vaultId: u32, reservedSecuritizationSpace: u128],
         { vaultId: u32; reservedSecuritizationSpace: u128 }
       >;
+      SecuritizationReserved: AugmentedEvent<
+        ApiType,
+        [
+          vaultId: u32,
+          locker: AccountId32,
+          securitizationCoverageMicrogons: u128,
+          feeRevenue: u128,
+          didUseFeeCoupon: bool,
+        ],
+        {
+          vaultId: u32;
+          locker: AccountId32;
+          securitizationCoverageMicrogons: u128;
+          feeRevenue: u128;
+          didUseFeeCoupon: bool;
+        }
+      >;
+      SecuritizationReturned: AugmentedEvent<
+        ApiType,
+        [vaultId: u32, amount: u128],
+        { vaultId: u32; amount: u128 }
+      >;
       TreasuryRecordingError: AugmentedEvent<
         ApiType,
         [vaultId: u32, frameId: u64, vaultEarnings: u128, error: SpRuntimeDispatchError],