refactor: stakeKeyStatus renamed StakeCredentialStatus

Author: AngelCastilloB

packages/core/src/Cardano/types/DelegationsAndRewards.ts

@@ -16,7 +16,7 @@ export interface Delegatee {
   nextNextEpoch?: StakePool;
 }
 
-export enum StakeKeyStatus {
+export enum StakeCredentialStatus {
   Registering = 'REGISTERING',
   Registered = 'REGISTERED',
   Unregistering = 'UNREGISTERING',
@@ -25,7 +25,7 @@ export enum StakeKeyStatus {
 
 export interface RewardAccountInfo {
   address: RewardAccount;
-  keyStatus: StakeKeyStatus;
+  credentialStatus: StakeCredentialStatus;
   delegatee?: Delegatee;
   rewardBalance: Lovelace;
   // Maybe add rewardsHistory for each reward account too

packages/e2e/src/tools/multi-delegation-data-gen/index.ts

@@ -72,8 +72,8 @@ const monitor = new TerminalProgressMonitor();
 
     monitor.startTask('Waiting for delegation to be updated on the wallet.');
     await rewardAccountStatuses(delegationWallet.delegation.rewardAccounts$, [
-      Cardano.StakeKeyStatus.Registering,
-      Cardano.StakeKeyStatus.Registered
+      Cardano.StakeCredentialStatus.Registering,
+      Cardano.StakeCredentialStatus.Registered
     ]);
     monitor.endTask('Delegation updated.', TaskResult.Success);
 

packages/e2e/src/tools/multi-delegation-data-gen/utils/utils.ts

@@ -44,12 +44,12 @@ const getPoolIds = async (wallet: PersonalWallet, count: number): Promise<Cardan
  */
 export const rewardAccountStatuses = async (
   rewardAccounts$: Observable<Cardano.RewardAccountInfo[]>,
-  statuses: Cardano.StakeKeyStatus[],
+  statuses: Cardano.StakeCredentialStatus[],
   timeout = MINUTE
 ) =>
   firstValueFromTimed(
     rewardAccounts$.pipe(
-      map((accts) => accts.map(({ keyStatus }) => keyStatus)),
+      map((accts) => accts.map(({ credentialStatus }) => credentialStatus)),
       filter((statusArr) => statusArr.every((s) => statuses.includes(s)))
     ),
     `Timeout waiting for all reward accounts stake keys to be one of ${statuses.join('|')}`,

packages/e2e/test/wallet/PersonalWallet/delegation.test.ts

@@ -33,7 +33,7 @@ const getWalletStateSnapshot = async (wallet: ObservableWallet) => {
   return {
     balance: { available: balanceAvailable, deposit, total: balanceTotal },
     epoch: epoch.epochNo,
-    isStakeKeyRegistered: rewardAccount.keyStatus === Cardano.StakeKeyStatus.Registered,
+    isStakeKeyRegistered: rewardAccount.credentialStatus === Cardano.StakeCredentialStatus.Registered,
     publicStakeKey,
     rewardAccount,
     rewardsBalance,
@@ -171,7 +171,7 @@ describe('PersonalWallet/delegation', () => {
 
     const stakeKeyHash = await bip32Ed25519.getPubKeyHash(tx1ConfirmedState.publicStakeKey.publicStakeKey);
     expect(stakeKeyHash).toEqual(Cardano.RewardAccount.toHash(tx1ConfirmedState.rewardAccount.address));
-    expect(tx1ConfirmedState.publicStakeKey.keyStatus).toBe(Cardano.StakeKeyStatus.Registered);
+    expect(tx1ConfirmedState.publicStakeKey.credentialStatus).toBe(Cardano.StakeCredentialStatus.Registered);
 
     // Make a 2nd tx with key de-registration
     const { tx: txDeregisterSigned } = await sourceWallet.createTxBuilder().delegatePortfolio(null).build().sign();
@@ -181,7 +181,7 @@ describe('PersonalWallet/delegation', () => {
 
     // No longer delegating
     expect(tx2ConfirmedState.rewardAccount.delegatee?.nextNextEpoch?.id).toBeUndefined();
-    expect(tx2ConfirmedState.publicStakeKey.keyStatus).toBe(Cardano.StakeKeyStatus.Unregistered);
+    expect(tx2ConfirmedState.publicStakeKey.credentialStatus).toBe(Cardano.StakeCredentialStatus.Unregistered);
 
     // Deposit is returned to wallet balance
     const expectedCoinsAfterTx2 = expectedCoinsAfterTx1 + stakeKeyDeposit - txDeregisterSigned.body.fee;

packages/e2e/test/wallet/PersonalWallet/delegationDistribution.test.ts

@@ -42,13 +42,13 @@ const fundWallet = async (wallet: PersonalWallet) => {
 /** await for rewardAccounts$ to be registered, unregistered, as defined in states   */
 const rewardAccountStatuses = async (
   rewardAccounts$: Observable<Cardano.RewardAccountInfo[]>,
-  statuses: Cardano.StakeKeyStatus[],
+  statuses: Cardano.StakeCredentialStatus[],
   timeout = MINUTE
 ) =>
   firstValueFromTimed(
     rewardAccounts$.pipe(
-      tap((accts) => accts.map(({ address, keyStatus }) => logger.debug(address, keyStatus))),
-      map((accts) => accts.map(({ keyStatus }) => keyStatus)),
+      tap((accts) => accts.map(({ address, credentialStatus }) => logger.debug(address, credentialStatus))),
+      map((accts) => accts.map(({ credentialStatus }) => credentialStatus)),
       filter((statusArr) => statusArr.every((s) => statuses.includes(s)))
     ),
     `Timeout waiting for all reward accounts stake keys to be one of ${statuses.join('|')}`,
@@ -61,7 +61,7 @@ const deregisterAllStakeKeys = async (wallet: PersonalWallet): Promise<void> =>
   try {
     await rewardAccountStatuses(
       wallet.delegation.rewardAccounts$,
-      [Cardano.StakeKeyStatus.Unregistered, Cardano.StakeKeyStatus.Unregistering],
+      [Cardano.StakeCredentialStatus.Unregistered, Cardano.StakeCredentialStatus.Unregistering],
       0
     );
     logger.info('Stake keys are already deregistered');
@@ -73,8 +73,8 @@ const deregisterAllStakeKeys = async (wallet: PersonalWallet): Promise<void> =>
     await submitAndConfirm(wallet, deregTx);
 
     await rewardAccountStatuses(wallet.delegation.rewardAccounts$, [
-      Cardano.StakeKeyStatus.Unregistered,
-      Cardano.StakeKeyStatus.Unregistering
+      Cardano.StakeCredentialStatus.Unregistered,
+      Cardano.StakeCredentialStatus.Unregistering
     ]);
     logger.info('Deregistered all stake keys');
   }
@@ -153,8 +153,8 @@ describe('PersonalWallet/delegationDistribution', () => {
     // Check that reward addresses were delegated
     await walletReady(wallet);
     await rewardAccountStatuses(wallet.delegation.rewardAccounts$, [
-      Cardano.StakeKeyStatus.Registering,
-      Cardano.StakeKeyStatus.Registered
+      Cardano.StakeCredentialStatus.Registering,
+      Cardano.StakeCredentialStatus.Registered
     ]);
     logger.debug('Delegations successfully done');
 

packages/tx-construction/src/tx-builder/TxBuilder.ts

@@ -220,8 +220,8 @@ export class GenericTxBuilder implements TxBuilder {
             const ownAddresses = await this.#dependencies.txBuilderProviders.addresses.get();
             const registeredRewardAccounts = (await this.#dependencies.txBuilderProviders.rewardAccounts()).filter(
               (acct) =>
-                acct.keyStatus === Cardano.StakeKeyStatus.Registered ||
-                acct.keyStatus === Cardano.StakeKeyStatus.Registering
+                acct.credentialStatus === Cardano.StakeCredentialStatus.Registered ||
+                acct.credentialStatus === Cardano.StakeCredentialStatus.Registering
             );
             const auxiliaryData = this.partialAuxiliaryData && { ...this.partialAuxiliaryData };
             const extraSigners = this.partialExtraSigners && [...this.partialExtraSigners];
@@ -373,7 +373,7 @@ export class GenericTxBuilder implements TxBuilder {
     // Reward accounts already delegated to the correct pool. Change must be distributed accordingly
     for (const accnt of rewardAccounts.filter(
       (rewardAccount) =>
-        rewardAccount.keyStatus === Cardano.StakeKeyStatus.Registered &&
+        rewardAccount.credentialStatus === Cardano.StakeCredentialStatus.Registered &&
         rewardAccount.delegatee?.nextNextEpoch &&
         this.#requestedPortfolio?.some(({ id }) => id === rewardAccount.delegatee?.nextNextEpoch?.id)
     ))
@@ -386,7 +386,7 @@ export class GenericTxBuilder implements TxBuilder {
     const availableRewardAccounts = rewardAccounts
       .filter(
         (rewardAccount) =>
-          rewardAccount.keyStatus === Cardano.StakeKeyStatus.Unregistered ||
+          rewardAccount.credentialStatus === Cardano.StakeCredentialStatus.Unregistered ||
           !rewardAccount.delegatee?.nextNextEpoch ||
           this.#requestedPortfolio?.every(({ id }) => id !== rewardAccount.delegatee?.nextNextEpoch?.id)
       )
@@ -406,7 +406,7 @@ export class GenericTxBuilder implements TxBuilder {
       const { id: newPoolId, weight } = newPools.pop()!;
       const rewardAccount = availableRewardAccounts.pop()!;
       this.#logger.debug(`Building delegation certificate for ${newPoolId} ${rewardAccount}`);
-      if (rewardAccount.keyStatus !== Cardano.StakeKeyStatus.Registered) {
+      if (rewardAccount.credentialStatus !== Cardano.StakeCredentialStatus.Registered) {
         certificates.push(Cardano.createStakeRegistrationCert(rewardAccount.address));
       }
       certificates.push(Cardano.createDelegationCert(rewardAccount.address, newPoolId));
@@ -416,7 +416,7 @@ export class GenericTxBuilder implements TxBuilder {
     // Deregister stake keys no longer needed
     this.#logger.debug(`De-registering ${availableRewardAccounts.length} stake keys`);
     for (const rewardAccount of availableRewardAccounts) {
-      if (rewardAccount.keyStatus === Cardano.StakeKeyStatus.Registered) {
+      if (rewardAccount.credentialStatus === Cardano.StakeCredentialStatus.Registered) {
         certificates.push(Cardano.createStakeDeregistrationCert(rewardAccount.address, rewardAccount.deposit));
       }
     }
@@ -428,7 +428,7 @@ export class GenericTxBuilder implements TxBuilder {
   static #sortRewardAccountsDelegatedFirst(a: RewardAccountWithPoolId, b: RewardAccountWithPoolId): number {
     const getScore = (acct: RewardAccountWithPoolId) => {
       let score = 2;
-      if (acct.keyStatus === Cardano.StakeKeyStatus.Registered) {
+      if (acct.credentialStatus === Cardano.StakeCredentialStatus.Registered) {
         score = 1;
         if (acct.delegatee?.nextNextEpoch) {
           score = 0;

packages/tx-construction/test/tx-builder/TxBuilder.bootstrap.test.ts

@@ -46,7 +46,7 @@ describe('TxBuilder bootstrap', () => {
       rewardAccounts: jest.fn().mockResolvedValue([
         {
           address: rewardAccount,
-          keyStatus: Cardano.StakeKeyStatus.Unregistered,
+          keyStatus: Cardano.StakeCredentialStatus.Unregistered,
           rewardBalance: mocks.rewardAccountBalance
         }
       ]),

packages/tx-construction/test/tx-builder/TxBuilder.test.ts

@@ -95,7 +95,7 @@ describe('GenericTxBuilder', () => {
       rewardAccounts: jest.fn().mockResolvedValue([
         {
           address: rewardAccount,
-          keyStatus: Cardano.StakeKeyStatus.Unregistered,
+          keyStatus: Cardano.StakeCredentialStatus.Unregistered,
           rewardBalance: mocks.rewardAccountBalance
         }
       ]),