Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions src/types/wallet-provisioning.types.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,47 @@
import type { TransitionMap } from '../utils/transitions'
import { canTransition } from '../utils/transitions'

export const WALLET_STATUSES = [
'RESERVED',
'PROVISIONING',
'RETRYABLE',
'ACTIVE',
'EXPORTING',
'MIGRATED',
'FAILED',
'DISABLED',
] as const

export type WalletStatus = (typeof WALLET_STATUSES)[number]

export const WALLET_TRANSITIONS: TransitionMap<WalletStatus> = {
RESERVED: ['PROVISIONING', 'FAILED'],
PROVISIONING: ['ACTIVE', 'RETRYABLE', 'FAILED'],
RETRYABLE: ['PROVISIONING', 'FAILED'],
ACTIVE: ['EXPORTING', 'DISABLED'],
EXPORTING: ['ACTIVE', 'MIGRATED', 'FAILED'],
MIGRATED: ['DISABLED'],
FAILED: ['RESERVED'],
DISABLED: [],
} as const

export function canTransitionWallet(from: WalletStatus, to: WalletStatus): boolean {
return canTransition(WALLET_TRANSITIONS, from, to)
}

export class InvalidWalletTransitionError extends Error {
constructor(readonly from: WalletStatus, readonly to: WalletStatus) {
super(`Cannot transition wallet status from '${from}' to '${to}'`)
this.name = 'InvalidWalletTransitionError'
}
}

export function assertValidWalletTransition(from: WalletStatus, to: WalletStatus): void {
if (!canTransitionWallet(from, to)) {
throw new InvalidWalletTransitionError(from, to)
}
}

export const WALLET_JOB_STATUSES = [
'PENDING',
'PROCESSING',
Expand Down
80 changes: 80 additions & 0 deletions tests/unit/wallet-transitions.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import { describe, expect, it } from 'vitest'
import {
assertValidWalletTransition,
canTransitionWallet,
InvalidWalletTransitionError,
WALLET_STATUSES,
WALLET_TRANSITIONS,
type WalletStatus,

Check warning on line 8 in tests/unit/wallet-transitions.test.ts

View workflow job for this annotation

GitHub Actions / Lint, typecheck, format, test

'WalletStatus' is defined but never used. Allowed unused vars must match /^I[A-Z]|^_/u
} from '../../src/types/wallet-provisioning.types'

describe('wallet status transitions and lifecycle guards', () => {
it('defines all required statuses', () => {
expect(WALLET_STATUSES).toEqual([
'RESERVED',
'PROVISIONING',
'RETRYABLE',
'ACTIVE',
'EXPORTING',
'MIGRATED',
'FAILED',
'DISABLED',
])
})

it('allows valid provisioning and lifecycle paths', () => {
// Normal provisioning flow
expect(canTransitionWallet('RESERVED', 'PROVISIONING')).toBe(true)
expect(canTransitionWallet('PROVISIONING', 'ACTIVE')).toBe(true)

// Retryable failure flow
expect(canTransitionWallet('PROVISIONING', 'RETRYABLE')).toBe(true)
expect(canTransitionWallet('RETRYABLE', 'PROVISIONING')).toBe(true)

// Export and migration flow
expect(canTransitionWallet('ACTIVE', 'EXPORTING')).toBe(true)
expect(canTransitionWallet('EXPORTING', 'MIGRATED')).toBe(true)
expect(canTransitionWallet('EXPORTING', 'ACTIVE')).toBe(true) // aborted/failed export returns to active

// Disabling and failure recovery
expect(canTransitionWallet('ACTIVE', 'DISABLED')).toBe(true)
expect(canTransitionWallet('MIGRATED', 'DISABLED')).toBe(true)
expect(canTransitionWallet('PROVISIONING', 'FAILED')).toBe(true)
expect(canTransitionWallet('FAILED', 'RESERVED')).toBe(true)
})

it('rejects illegal or out-of-order state transitions', () => {
// Cannot skip provisioning
expect(canTransitionWallet('RESERVED', 'ACTIVE')).toBe(false)
expect(canTransitionWallet('RESERVED', 'MIGRATED')).toBe(false)

// Cannot transition from terminal DISABLED state
expect(canTransitionWallet('DISABLED', 'ACTIVE')).toBe(false)
expect(canTransitionWallet('DISABLED', 'RESERVED')).toBe(false)

// Cannot jump straight to migrated without export
expect(canTransitionWallet('ACTIVE', 'MIGRATED')).toBe(false)

// Self transitions are not permitted
WALLET_STATUSES.forEach((status) => {
expect(canTransitionWallet(status, status)).toBe(false)
})
})

it('throws InvalidWalletTransitionError on illegal transitions via assertValidWalletTransition', () => {
expect(() => assertValidWalletTransition('RESERVED', 'ACTIVE')).toThrow(
InvalidWalletTransitionError,
)
expect(() => assertValidWalletTransition('DISABLED', 'ACTIVE')).toThrow(
"Cannot transition wallet status from 'DISABLED' to 'ACTIVE'",

Check failure on line 69 in tests/unit/wallet-transitions.test.ts

View workflow job for this annotation

GitHub Actions / Lint, typecheck, format, test

Strings must use singlequote
)
expect(() => assertValidWalletTransition('ACTIVE', 'EXPORTING')).not.toThrow()
})

it('has exhaustive transition entries for every status', () => {
for (const status of WALLET_STATUSES) {
expect(WALLET_TRANSITIONS).toHaveProperty(status)
expect(Array.isArray(WALLET_TRANSITIONS[status])).toBe(true)
}
})
})
Loading