@argonprotocol/mainchain 1.4.12 → 1.4.13-dev.b31b2822

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,
@@ -32,6 +31,7 @@ import type {
   ArgonPrimitivesNotaryNotaryMeta,
   ArgonPrimitivesNotaryNotaryRecord,
   ArgonPrimitivesProvidersOperationalRewardKind,
+  ArgonPrimitivesVaultBitcoinSecuritizationBasis,
   ArgonRuntimeOriginCaller,
   ArgonRuntimeProxyType,
   ArgonRuntimeRuntimeHoldReason,
@@ -311,139 +311,216 @@ declare module '@polkadot/api-base/types/events' {
         { who: AccountId32; amount: u128 }
       >;
     };
-    bitcoinLocks: {
-      BitcoinCosignPastDue: AugmentedEvent<
+    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,
-        [utxoId: u64, vaultId: u32, compensationAmount: u128, compensatedAccountId: AccountId32],
-        { utxoId: u64; vaultId: u32; compensationAmount: u128; compensatedAccountId: AccountId32 }
+        [accountId: AccountId32, fissionId: u64, lockId: u64],
+        { accountId: AccountId32; fissionId: u64; lockId: u64 }
+      >;
+      /**
+       * A Fission was created and allocated from its source Lock.
+       **/
+      FissionCreated: AugmentedEvent<
+        ApiType,
+        [
+          accountId: AccountId32,
+          fissionId: u64,
+          liquidId: u64,
+          lockId: u64,
+          satoshis: u64,
+          microgonsAtTargetPerBtc: u128,
+          liquidityPromised: u128,
+        ],
+        {
+          accountId: AccountId32;
+          fissionId: u64;
+          liquidId: u64;
+          lockId: 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;
+        }
       >;
-      BitcoinLockBurned: AugmentedEvent<
+    };
+    bitcoinLocks: {
+      BitcoinCosignPastDue: 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,
-          liquidityPromised: u128,
-          securitization: u128,
-          lockedTargetPrice: u128,
+          securitizationBasis: ArgonPrimitivesVaultBitcoinSecuritizationBasis,
+          collateralRequired: u128,
           accountId: AccountId32,
           securityFee: u128,
         ],
         {
-          utxoId: u64;
+          lockId: u64;
           vaultId: u32;
-          liquidityPromised: u128;
-          securitization: u128;
-          lockedTargetPrice: u128;
+          securitizationBasis: ArgonPrimitivesVaultBitcoinSecuritizationBasis;
+          collateralRequired: u128;
           accountId: AccountId32;
           securityFee: u128;
         }
       >;
       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 }
       >;
-      BitcoinLockRatcheted: AugmentedEvent<
+      BitcoinLockResecuritized: AugmentedEvent<
         ApiType,
         [
-          utxoId: u64,
+          lockId: u64,
           vaultId: u32,
-          liquidityPromised: u128,
-          oldTargetPrice: u128,
-          securityFee: u128,
-          newTargetPrice: u128,
-          amountBurned: u128,
+          securitizationBasis: ArgonPrimitivesVaultBitcoinSecuritizationBasis,
           accountId: AccountId32,
         ],
         {
-          utxoId: u64;
+          lockId: u64;
           vaultId: u32;
-          liquidityPromised: u128;
-          oldTargetPrice: u128;
-          securityFee: u128;
-          newTargetPrice: u128;
-          amountBurned: 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, 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;
           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 }
+        [lockId: u64, utxoRef: ArgonPrimitivesBitcoinUtxoRef, vaultId: u32, satoshis: u64],
+        { lockId: u64; utxoRef: ArgonPrimitivesBitcoinUtxoRef; vaultId: u32; satoshis: u64 }
       >;
-      UtxoFundedFromCandidate: AugmentedEvent<
+      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;
@@ -451,47 +528,37 @@ declare module '@polkadot/api-base/types/events' {
       >;
     };
     bitcoinUtxos: {
-      UtxoRejected: AugmentedEvent<
+      UtxoDetected: AugmentedEvent<
         ApiType,
         [
-          utxoId: u64,
+          lockId: u64,
           utxoRef: ArgonPrimitivesBitcoinUtxoRef,
-          rejectedReason: ArgonPrimitivesBitcoinBitcoinRejectedReason,
           satoshisReceived: u64,
+          bitcoinHeight: u64,
         ],
         {
-          utxoId: u64;
+          lockId: u64;
           utxoRef: ArgonPrimitivesBitcoinUtxoRef;
-          rejectedReason: ArgonPrimitivesBitcoinBitcoinRejectedReason;
           satoshisReceived: u64;
+          bitcoinHeight: u64;
         }
       >;
-      UtxoRejectedError: AugmentedEvent<
+      UtxoDetectedError: AugmentedEvent<
         ApiType,
-        [utxoId: u64, error: SpRuntimeDispatchError],
-        { utxoId: u64; error: SpRuntimeDispatchError }
+        [lockId: u64, error: SpRuntimeDispatchError],
+        { lockId: u64; error: SpRuntimeDispatchError }
       >;
       UtxoSpent: AugmentedEvent<
         ApiType,
-        [utxoId: u64, blockHeight: u64],
-        { utxoId: u64; 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 }
-      >;
-      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 }
+        [lockId: u64, error: SpRuntimeDispatchError],
+        { lockId: u64; error: SpRuntimeDispatchError }
       >;
+      UtxoUnwatched: AugmentedEvent<ApiType, [lockId: u64], { lockId: u64 }>;
     };
     blockRewards: {
       RewardCreated: AugmentedEvent<
@@ -1104,8 +1171,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, 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
@@ -1125,14 +1192,16 @@ declare module '@polkadot/api-base/types/events' {
         [
           mintType: PalletMintMintType,
           accountId: AccountId32,
-          utxoId: Option<u64>,
+          fissionId: Option<u64>,
+          lockId: Option<u64>,
           amount: u128,
           error: SpRuntimeDispatchError,
         ],
         {
           mintType: PalletMintMintType;
           accountId: AccountId32;
-          utxoId: Option<u64>;
+          fissionId: Option<u64>;
+          lockId: Option<u64>;
           amount: u128;
           error: SpRuntimeDispatchError;
         }
@@ -2106,30 +2175,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],
@@ -2147,14 +2192,48 @@ 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,
         [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],