@argonprotocol/mainchain 1.4.12-dev.4d726964 → 1.4.12-dev.9deec2d7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@argonprotocol/mainchain",
-  "version": "1.4.12-dev.4d726964",
+  "version": "1.4.12-dev.9deec2d7",
   "description": "A client for accessing the Argon mainchain apis.",
   "repository": {
     "type": "git",
@@ -67,7 +67,7 @@
   },
   "devDependencies": {
     "@argonprotocol/ethereum-contracts": "workspace:*",
-    "@argonprotocol/testing": "1.4.12-dev.4d726964",
+    "@argonprotocol/testing": "1.4.12-dev.9deec2d7",
     "@polkadot/typegen": "^16.5.6",
     "@substrate/ss58-registry": "^1.51.0",
     "@types/node": "^20",
@@ -75,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

@@ -92,14 +92,18 @@ declare module '@polkadot/api-base/types/consts' {
        **/
       maxConcurrentlyReleasingLocks: u32 & AugmentedConst<ApiType>;
       /**
-       * Max bitcoin blocks up to which the first observed output may fund the Lock.
+       * Maximum number of confirmed Bitcoin outputs that may fund one Lock.
        **/
-      maxPendingConfirmationBlocks: u64 & AugmentedConst<ApiType>;
+      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
        **/

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

@@ -160,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
        **/
@@ -218,6 +226,10 @@ declare module '@polkadot/api-base/types/errors' {
        **/
       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
        **/
@@ -245,15 +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
        **/
@@ -313,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
        **/
@@ -332,10 +352,6 @@ declare module '@polkadot/api-base/types/errors' {
        * 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
        **/

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

@@ -31,6 +31,7 @@ import type {
   ArgonPrimitivesNotaryNotaryMeta,
   ArgonPrimitivesNotaryNotaryRecord,
   ArgonPrimitivesProvidersOperationalRewardKind,
+  ArgonPrimitivesVaultBitcoinSecuritizationBasis,
   ArgonRuntimeOriginCaller,
   ArgonRuntimeProxyType,
   ArgonRuntimeRuntimeHoldReason,
@@ -324,8 +325,8 @@ declare module '@polkadot/api-base/types/events' {
        **/
       FissionClosedByLock: AugmentedEvent<
         ApiType,
-        [accountId: AccountId32, fissionId: u64, utxoId: u64],
-        { accountId: AccountId32; fissionId: u64; utxoId: u64 }
+        [accountId: AccountId32, fissionId: u64, lockId: u64],
+        { accountId: AccountId32; fissionId: u64; lockId: u64 }
       >;
       /**
        * A Fission was created and allocated from its source Lock.
@@ -336,7 +337,7 @@ declare module '@polkadot/api-base/types/events' {
           accountId: AccountId32,
           fissionId: u64,
           liquidId: u64,
-          utxoId: u64,
+          lockId: u64,
           satoshis: u64,
           microgonsAtTargetPerBtc: u128,
           liquidityPromised: u128,
@@ -345,7 +346,7 @@ declare module '@polkadot/api-base/types/events' {
           accountId: AccountId32;
           fissionId: u64;
           liquidId: u64;
-          utxoId: u64;
+          lockId: u64;
           satoshis: u64;
           microgonsAtTargetPerBtc: u128;
           liquidityPromised: u128;
@@ -379,30 +380,35 @@ declare module '@polkadot/api-base/types/events' {
     bitcoinLocks: {
       BitcoinCosignPastDue: AugmentedEvent<
         ApiType,
-        [utxoId: u64, vaultId: u32, compensationAmount: u128, compensatedAccountId: AccountId32],
-        { utxoId: u64; vaultId: u32; compensationAmount: u128; compensatedAccountId: AccountId32 }
-      >;
-      BitcoinLockBurned: AugmentedEvent<
-        ApiType,
-        [utxoId: u64, vaultId: u32, wasUtxoSpent: bool],
-        { utxoId: u64; vaultId: u32; wasUtxoSpent: bool }
+        [
+          lockId: u64,
+          vaultId: u32,
+          releaseNumber: u32,
+          compensationAmount: u128,
+          compensatedAccountId: AccountId32,
+        ],
+        {
+          lockId: u64;
+          vaultId: u32;
+          releaseNumber: u32;
+          compensationAmount: u128;
+          compensatedAccountId: AccountId32;
+        }
       >;
       BitcoinLockCreated: AugmentedEvent<
         ApiType,
         [
-          utxoId: u64,
+          lockId: u64,
           vaultId: u32,
-          securitizedSatoshis: u64,
-          microgonsAtTargetPerBtc: u128,
+          securitizationBasis: ArgonPrimitivesVaultBitcoinSecuritizationBasis,
           collateralRequired: u128,
           accountId: AccountId32,
           securityFee: u128,
         ],
         {
-          utxoId: u64;
+          lockId: u64;
           vaultId: u32;
-          securitizedSatoshis: u64;
-          microgonsAtTargetPerBtc: u128;
+          securitizationBasis: ArgonPrimitivesVaultBitcoinSecuritizationBasis;
           collateralRequired: u128;
           accountId: AccountId32;
           securityFee: u128;
@@ -410,76 +416,79 @@ declare module '@polkadot/api-base/types/events' {
       >;
       BitcoinLockFlexibleChanged: AugmentedEvent<
         ApiType,
-        [utxoId: u64, vaultId: u32, isFlexible: bool],
-        { utxoId: u64; vaultId: u32; isFlexible: bool }
+        [lockId: u64, vaultId: u32, isFlexible: bool],
+        { lockId: u64; vaultId: u32; isFlexible: bool }
       >;
       BitcoinLockResecuritized: AugmentedEvent<
         ApiType,
         [
-          utxoId: u64,
+          lockId: u64,
           vaultId: u32,
-          securitizedSatoshis: u64,
-          microgonsAtTargetPerBtc: u128,
+          securitizationBasis: ArgonPrimitivesVaultBitcoinSecuritizationBasis,
           accountId: AccountId32,
         ],
         {
-          utxoId: u64;
+          lockId: u64;
           vaultId: u32;
-          securitizedSatoshis: u64;
-          microgonsAtTargetPerBtc: u128;
+          securitizationBasis: ArgonPrimitivesVaultBitcoinSecuritizationBasis;
           accountId: AccountId32;
         }
       >;
+      BitcoinLockTerminated: AugmentedEvent<
+        ApiType,
+        [lockId: u64, vaultId: u32, wasUtxoSpent: bool, burnedArgons: u128],
+        { lockId: u64; vaultId: u32; wasUtxoSpent: bool; burnedArgons: u128 }
+      >;
       BitcoinSpentAfterRelease: AugmentedEvent<
         ApiType,
-        [utxoId: u64, vaultId: u32],
-        { utxoId: u64; vaultId: u32 }
+        [lockId: u64, vaultId: u32, releaseNumber: u32, bitcoinHeight: u64],
+        { lockId: u64; vaultId: u32; releaseNumber: u32; bitcoinHeight: u64 }
       >;
       BitcoinUtxoCosigned: AugmentedEvent<
         ApiType,
-        [utxoId: u64, vaultId: u32, signature: Bytes],
-        { utxoId: u64; vaultId: u32; signature: Bytes }
+        [lockId: u64, vaultId: u32, releaseNumber: u32, signatures: Vec<Bytes>],
+        { lockId: u64; vaultId: u32; releaseNumber: u32; signatures: Vec<Bytes> }
       >;
       BitcoinUtxoCosignRequested: AugmentedEvent<
         ApiType,
-        [utxoId: u64, vaultId: u32],
-        { utxoId: u64; vaultId: u32 }
+        [lockId: u64, vaultId: u32, releaseNumber: u32],
+        { lockId: u64; vaultId: u32; releaseNumber: u32 }
       >;
       /**
        * An error occurred while refunding an overdue cosigned bitcoin lock
        **/
       CosignOverdueError: AugmentedEvent<
         ApiType,
-        [utxoId: u64, error: SpRuntimeDispatchError],
-        { utxoId: u64; error: SpRuntimeDispatchError }
+        [lockId: u64, error: SpRuntimeDispatchError],
+        { lockId: u64; error: SpRuntimeDispatchError }
       >;
       /**
        * An error occurred while completing a lock
        **/
       LockExpirationError: AugmentedEvent<
         ApiType,
-        [utxoId: u64, error: SpRuntimeDispatchError],
-        { utxoId: u64; error: SpRuntimeDispatchError }
+        [lockId: u64, error: SpRuntimeDispatchError],
+        { lockId: 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 }
+        [accountId: AccountId32, lockId: u64, expirationFrame: u64],
+        { accountId: AccountId32; lockId: u64; expirationFrame: u64 }
       >;
       OrphanedUtxoCosigned: AugmentedEvent<
         ApiType,
         [
-          utxoId: u64,
+          lockId: u64,
           utxoRef: ArgonPrimitivesBitcoinUtxoRef,
           vaultId: u32,
           accountId: AccountId32,
           signature: Bytes,
         ],
         {
-          utxoId: u64;
+          lockId: u64;
           utxoRef: ArgonPrimitivesBitcoinUtxoRef;
           vaultId: u32;
           accountId: AccountId32;
@@ -504,14 +513,14 @@ declare module '@polkadot/api-base/types/events' {
       >;
       OrphanedUtxoReceived: AugmentedEvent<
         ApiType,
-        [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, satoshis: u64],
-        { utxoId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; vaultId: u32; satoshis: u64 }
+        [lockId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, satoshis: u64],
+        { lockId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; vaultId: u32; satoshis: u64 }
       >;
       OrphanedUtxoReleaseRequested: AugmentedEvent<
         ApiType,
-        [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, accountId: AccountId32],
+        [lockId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, accountId: AccountId32],
         {
-          utxoId: u64;
+          lockId: u64;
           utxoRef: ArgonPrimitivesBitcoinUtxoRef;
           vaultId: u32;
           accountId: AccountId32;
@@ -522,13 +531,13 @@ declare module '@polkadot/api-base/types/events' {
       UtxoDetected: AugmentedEvent<
         ApiType,
         [
-          utxoId: u64,
+          lockId: u64,
           utxoRef: ArgonPrimitivesBitcoinUtxoRef,
           satoshisReceived: u64,
           bitcoinHeight: u64,
         ],
         {
-          utxoId: u64;
+          lockId: u64;
           utxoRef: ArgonPrimitivesBitcoinUtxoRef;
           satoshisReceived: u64;
           bitcoinHeight: u64;
@@ -536,20 +545,20 @@ declare module '@polkadot/api-base/types/events' {
       >;
       UtxoDetectedError: AugmentedEvent<
         ApiType,
-        [utxoId: u64, error: SpRuntimeDispatchError],
-        { utxoId: u64; error: SpRuntimeDispatchError }
+        [lockId: u64, error: SpRuntimeDispatchError],
+        { lockId: u64; error: SpRuntimeDispatchError }
       >;
       UtxoSpent: AugmentedEvent<
         ApiType,
-        [utxoId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, blockHeight: u64],
-        { utxoId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; blockHeight: u64 }
+        [lockId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, blockHeight: u64],
+        { lockId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; blockHeight: u64 }
       >;
       UtxoSpentError: AugmentedEvent<
         ApiType,
-        [utxoId: u64, error: SpRuntimeDispatchError],
-        { utxoId: u64; error: SpRuntimeDispatchError }
+        [lockId: u64, error: SpRuntimeDispatchError],
+        { lockId: u64; error: SpRuntimeDispatchError }
       >;
-      UtxoUnwatched: AugmentedEvent<ApiType, [utxoId: u64], { utxoId: u64 }>;
+      UtxoUnwatched: AugmentedEvent<ApiType, [lockId: u64], { lockId: u64 }>;
     };
     blockRewards: {
       RewardCreated: AugmentedEvent<
@@ -1162,8 +1171,8 @@ declare module '@polkadot/api-base/types/events' {
        **/
       BitcoinMint: AugmentedEvent<
         ApiType,
-        [accountId: AccountId32, fissionId: u64, utxoId: Option<u64>, amount: u128],
-        { accountId: AccountId32; fissionId: u64; utxoId: Option<u64>; amount: u128 }
+        [accountId: AccountId32, fissionId: u64, lockId: Option<u64>, amount: u128],
+        { accountId: AccountId32; fissionId: u64; lockId: Option<u64>; amount: u128 }
       >;
       /**
        * The amount of microgons minted for mining. NOTE: accounts below Existential Deposit
@@ -1184,7 +1193,7 @@ declare module '@polkadot/api-base/types/events' {
           mintType: PalletMintMintType,
           accountId: AccountId32,
           fissionId: Option<u64>,
-          utxoId: Option<u64>,
+          lockId: Option<u64>,
           amount: u128,
           error: SpRuntimeDispatchError,
         ],
@@ -1192,7 +1201,7 @@ declare module '@polkadot/api-base/types/events' {
           mintType: PalletMintMintType;
           accountId: AccountId32;
           fissionId: Option<u64>;
-          utxoId: Option<u64>;
+          lockId: Option<u64>;
           amount: u128;
           error: SpRuntimeDispatchError;
         }
@@ -2183,8 +2192,20 @@ declare module '@polkadot/api-base/types/events' {
       >;
       LostBitcoinCompensated: AugmentedEvent<
         ApiType,
-        [vaultId: u32, beneficiary: AccountId32, toBeneficiary: u128, burned: u128],
-        { vaultId: u32; beneficiary: AccountId32; toBeneficiary: u128; burned: u128 }
+        [
+          vaultId: u32,
+          beneficiary: AccountId32,
+          toBeneficiary: u128,
+          shortfall: u128,
+          burned: u128,
+        ],
+        {
+          vaultId: u32;
+          beneficiary: AccountId32;
+          toBeneficiary: u128;
+          shortfall: u128;
+          burned: u128;
+        }
       >;
       ReservedSecuritizationSpaceChanged: AugmentedEvent<
         ApiType,