Skip to content

feat: Add mainnet deployment readiness security features #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SudiptaPaul-31 merged 1 commit into from
Jun 24, 2026
Merged

feat: Add mainnet deployment readiness security features #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
462 changes: 462 additions & 0 deletions docs/DEPLOYMENT_GUIDE.md
View file
Open in desktop

Large diffs are not rendered by default.

340 changes: 340 additions & 0 deletions docs/SECURITY_AUDIT_CHECKLIST.md
View file
Open in desktop

Large diffs are not rendered by default.

600 changes: 600 additions & 0 deletions docs/THREAT_MODELING.md
View file
Open in desktop

Large diffs are not rendered by default.

291 changes: 197 additions & 94 deletions lib/escrow/service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,34 @@ import {

import { sorobanEscrowAdapter } from './blockchain'
import { escrowRepository } from './repository'
import {
executeCriticalOperation,
type CriticalOperationType,
initializeFailSafe,
} from '@/lib/security/failSafe'

// ---------------------------------------------------------------------------
// Service class
// ---------------------------------------------------------------------------

export class EscrowService {
private failSafeInitialized = false

constructor(
private readonly blockchain: IEscrowBlockchainAdapter = sorobanEscrowAdapter,
private readonly repo: IEscrowRepository = escrowRepository
) {}

/**
* Initialize fail-safe system (call this on application startup)
*/
async initialize(): Promise<void> {
if (!this.failSafeInitialized) {
await initializeFailSafe()
this.failSafeInitialized = true
}
}

// =========================================================================
// createEscrow
// =========================================================================
Expand Down Expand Up @@ -169,33 +186,63 @@ export class EscrowService {
throw new EscrowInvalidStateError('Contract has no escrow address — deploy first')
}

// --- Verify on-chain ---
const verification = await this.blockchain.verifyFunding({
contractAddress: contract.escrowAddress,
txHash: input.fundingTxHash,
expectedAmount: input.amount,
currency: contract.currency,
})

if (!verification.verified) {
throw new EscrowFundingVerificationError(
`Funding verification failed: on-chain amount ${verification.onChainAmount} does not match expected ${input.amount}`
)
}

const now = new Date().toISOString()
const updated = await this.repo.updateContractEscrowStatus(
contract.id,
'funded',
// --- Execute with fail-safe ---
const { operation, result } = await executeCriticalOperation(
{
fundedAt: now,
fundingTxHash: input.fundingTxHash,
status: 'active',
startedAt: now,
type: 'escrow_fund' as CriticalOperationType,
userId: parseInt(contract.clientId, 10),
walletAddress: input.callerWalletAddress,
resourceId: contract.id,
data: {
contractId: input.contractId,
fundingTxHash: input.fundingTxHash,
amount: input.amount,
},
amount: Number(input.amount),
},
async () => {
// --- Verify on-chain ---
if (!contract.escrowAddress) {
throw new EscrowInvalidStateError('Contract has no escrow address')
}

const verification = await this.blockchain.verifyFunding({
contractAddress: contract.escrowAddress,
txHash: input.fundingTxHash,
expectedAmount: input.amount,
currency: contract.currency,
})

if (!verification.verified) {
throw new EscrowFundingVerificationError(
`Funding verification failed: on-chain amount ${verification.onChainAmount} does not match expected ${input.amount}`
)
}

const now = new Date().toISOString()
const updated = await this.repo.updateContractEscrowStatus(
contract.id,
'funded',
{
fundedAt: now,
fundingTxHash: input.fundingTxHash,
status: 'active',
startedAt: now,
}
)

return { contract: updated, fundedAt: now }
}
)

return { contract: updated, fundedAt: now }
// If operation requires approval, return pending status
if (operation.requiresApproval && operation.status === 'pending') {
throw new EscrowInvalidStateError(
'Operation requires admin approval. Please wait for approval before proceeding.'
)
}

return result
}

// =========================================================================
Expand Down Expand Up @@ -246,55 +293,85 @@ export class EscrowService {
throw new EscrowInvalidStateError('Contract has no escrow address')
}

// --- Resolve freelancer wallet ---
const freelancerWallet = await this.repo.getUserWalletAddress(contract.freelancerId)
if (!freelancerWallet) {
throw new EscrowValidationError('Freelancer wallet address not found')
}

// --- Trigger on-chain release ---
let release: { txHash: string }
try {
release = await this.blockchain.releaseMilestoneFunds({
contractAddress: contract.escrowAddress,
milestoneId: milestone.id,
recipientAddress: freelancerWallet,
amount: milestone.amount,
currency: milestone.currency,
})
} catch (err) {
if (err instanceof EscrowBlockchainError) throw err
throw new EscrowBlockchainError('Failed to release milestone funds on-chain', err)
}

const now = new Date().toISOString()
// --- Execute with fail-safe ---
const { operation, result } = await executeCriticalOperation(
{
type: 'escrow_release' as CriticalOperationType,
userId: parseInt(contract.clientId, 10),
walletAddress: input.callerWalletAddress,
resourceId: milestone.id,
data: {
contractId: input.contractId,
milestoneId: input.milestoneId,
amount: milestone.amount,
},
amount: Number(milestone.amount),
},
async () => {
// --- Resolve freelancer wallet ---
const freelancerWallet = await this.repo.getUserWalletAddress(contract.freelancerId)
if (!freelancerWallet) {
throw new EscrowValidationError('Freelancer wallet address not found')
}

// --- Trigger on-chain release ---
if (!contract.escrowAddress) {
throw new EscrowInvalidStateError('Contract has no escrow address')
}

let release: { txHash: string }
try {
release = await this.blockchain.releaseMilestoneFunds({
contractAddress: contract.escrowAddress,
milestoneId: milestone.id,
recipientAddress: freelancerWallet,
amount: milestone.amount,
currency: milestone.currency,
})
} catch (err) {
if (err instanceof EscrowBlockchainError) throw err
throw new EscrowBlockchainError('Failed to release milestone funds on-chain', err)
}

const now = new Date().toISOString()

// --- Update milestone ---
const updatedMilestone = await this.repo.updateMilestoneStatus(
milestone.id,
'paid',
{ releaseTxHash: release.txHash, paidAt: now }
)

// --- Update milestone ---
const updatedMilestone = await this.repo.updateMilestoneStatus(
milestone.id,
'paid',
{ releaseTxHash: release.txHash, paidAt: now }
)
// --- Determine new escrow / contract status ---
const allMilestones = await this.repo.getMilestonesByContractId(contract.id)
const allPaid = allMilestones.every(
(m) => m.id === milestone.id ? true : m.status === 'paid'
)

// --- Determine new escrow / contract status ---
const allMilestones = await this.repo.getMilestonesByContractId(contract.id)
const allPaid = allMilestones.every(
(m) => m.id === milestone.id ? true : m.status === 'paid'
)
const newEscrowStatus = allPaid ? 'fully_released' : 'partially_released'
const updatedContract = await this.repo.updateContractEscrowStatus(
contract.id,
newEscrowStatus,
allPaid ? { status: 'completed', completedAt: now } : undefined
)

const newEscrowStatus = allPaid ? 'fully_released' : 'partially_released'
const updatedContract = await this.repo.updateContractEscrowStatus(
contract.id,
newEscrowStatus,
allPaid ? { status: 'completed', completedAt: now } : undefined
return {
milestone: updatedMilestone,
contract: updatedContract,
releaseTxHash: release.txHash,
allMilestonesPaid: allPaid,
}
}
)

return {
milestone: updatedMilestone,
contract: updatedContract,
releaseTxHash: release.txHash,
allMilestonesPaid: allPaid,
// If operation requires approval, return pending status
if (operation.requiresApproval && operation.status === 'pending') {
throw new EscrowInvalidStateError(
'Operation requires admin approval. Please wait for approval before proceeding.'
)
}

return result
}

// =========================================================================
Expand Down Expand Up @@ -337,38 +414,64 @@ export class EscrowService {
throw new EscrowInvalidStateError('Contract has no escrow address')
}

// --- Resolve client wallet ---
const clientWallet = await this.repo.getUserWalletAddress(contract.clientId)
if (!clientWallet) {
throw new EscrowValidationError('Client wallet address not found')
}

// --- Trigger on-chain refund ---
let refund: { txHash: string }
try {
refund = await this.blockchain.refundEscrow({
contractAddress: contract.escrowAddress,
clientAddress: clientWallet,
amount: contract.totalAmount,
currency: contract.currency,
})
} catch (err) {
if (err instanceof EscrowBlockchainError) throw err
throw new EscrowBlockchainError('Failed to refund escrow on-chain', err)
}

const now = new Date().toISOString()
const updatedContract = await this.repo.updateContractEscrowStatus(
contract.id,
'refunded',
// --- Execute with fail-safe ---
const { operation, result } = await executeCriticalOperation(
{
status: 'cancelled',
cancelledAt: now,
cancellationReason: input.reason,
type: 'escrow_refund' as CriticalOperationType,
userId: parseInt(contract.clientId, 10),
walletAddress: input.callerWalletAddress,
resourceId: contract.id,
data: {
contractId: input.contractId,
reason: input.reason,
amount: contract.totalAmount,
},
amount: Number(contract.totalAmount),
},
async () => {
// --- Resolve client wallet ---
const clientWallet = await this.repo.getUserWalletAddress(contract.clientId)
if (!clientWallet) {
throw new EscrowValidationError('Client wallet address not found')
}

// --- Trigger on-chain refund ---
let refund: { txHash: string }
try {
refund = await this.blockchain.refundEscrow({
contractAddress: contract.escrowAddress,
clientAddress: clientWallet,
amount: contract.totalAmount,
currency: contract.currency,
})
} catch (err) {
if (err instanceof EscrowBlockchainError) throw err
throw new EscrowBlockchainError('Failed to refund escrow on-chain', err)
}

const now = new Date().toISOString()
const updatedContract = await this.repo.updateContractEscrowStatus(
contract.id,
'refunded',
{
status: 'cancelled',
cancelledAt: now,
cancellationReason: input.reason,
}
)

return { contract: updatedContract, refundTxHash: refund.txHash }
}
)

return { contract: updatedContract, refundTxHash: refund.txHash }
// If operation requires approval, return pending status
if (operation.requiresApproval && operation.status === 'pending') {
throw new EscrowInvalidStateError(
'Operation requires admin approval. Please wait for approval before proceeding.'
)
}

return result
}

// =========================================================================
Expand Down
Loading
Loading