aiolabs/bitspire
9
0
Fork 0
Code Issues 52 Pull requests 2 Projects Releases Packages Wiki Activity Actions

refactor: rename grossSats → principalSats for terminology consistency

Browse source 
"Gross" was operator-vs-customer ambiguous (cash-out: customer's gross
payment = principal + commission, not the variable's value). atm-tui
already settled on "principal" for the same quantity (bitspire/atm-tui
src/db.zig:166-171, src/main.zig:98,716), and #44's Payment.extra
proposal will surface it as `principal_sats` on the kind-21000 wire.
Aligning the internal name removes one translation step across DB →
TUI → state machine → wire envelope.

Pure mechanical rename — no behavioral change. Also rewrites the
computeFeeSats JSDoc to drop the "gross"/"net" framing and document
the principalSats / on-wire satsAmount relationship explicitly.

Refs aiolabs/lamassu-next#44

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
Padreug 2026-05-14 15:24:53 +02:00
commit ec14bb16c6
3 changed files with 25 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

23
apps/machine/src/stores/atm.ts
View file

@ -28,13 +28,16 @@ const isElectron = typeof window !== 'undefined' && window.electronAPI !== undef
/**
* Compute fee in sats from context.
* Cash-in: customer gets net (gross - fee). Cash-out: customer pays gross + fee.
*
* principalSats = market-rate sats for the fiat amount (fiat × exchangeRate, no commission).
* Cash-in: on-wire satsAmount = principalSats - feeSats (customer receives less than principal)
* Cash-out: on-wire satsAmount = principalSats + feeSats (customer pays more than principal)
*/
function computeFeeSats(ctx: ATMContext, isCashIn: boolean): number {
const grossSats = ctx.exchangeRate > 0 ? Math.floor((ctx.fiatCents / 100) * ctx.exchangeRate) : 0
const principalSats = ctx.exchangeRate > 0 ? Math.floor((ctx.fiatCents / 100) * ctx.exchangeRate) : 0
const feeSats = isCashIn
? grossSats - ctx.satsAmount // cash-in: customer gets net
: ctx.satsAmount - grossSats // cash-out: customer pays gross + fee
? principalSats - ctx.satsAmount // cash-in: customer receives less than principal
: ctx.satsAmount - principalSats // cash-out: customer pays more than principal
return Math.max(0, feeSats)
}
@ -850,9 +853,9 @@ export const useAtmStore = defineStore('atm', () => {
// Calculate what the new sats amount would be
const newFiatCents = ctx.fiatCents + denomination * 100
const newFiatUnits = newFiatCents / 100
const grossSats = Math.floor(newFiatUnits * ctx.exchangeRate)
const fee = Math.floor(grossSats * ctx.feePercent)
const newSatsAmount = grossSats - fee
const principalSats = Math.floor(newFiatUnits * ctx.exchangeRate)
const fee = Math.floor(principalSats * ctx.feePercent)
const newSatsAmount = principalSats - fee
// Check against available balance
if (newSatsAmount > ctx.availableBalance) {
@ -1106,9 +1109,9 @@ export const useAtmStore = defineStore('atm', () => {
// Calculate if this bill would exceed available balance
const newFiatCents = ctx.fiatCents + denomination * 100
const newFiatUnits = newFiatCents / 100
const grossSats = Math.floor(newFiatUnits * ctx.exchangeRate)
const fee = Math.floor(grossSats * ctx.feePercent)
const newSatsAmount = grossSats - fee
const principalSats = Math.floor(newFiatUnits * ctx.exchangeRate)
const fee = Math.floor(principalSats * ctx.feePercent)
const newSatsAmount = principalSats - fee
if (newSatsAmount > ctx.availableBalance) {
console.log(

6
apps/machine/src/views/CashInView.vue
View file

@ -120,9 +120,9 @@ function canAcceptBill(denomination: number): boolean {
if (!ctx) return false
if (ctx.availableBalance <= 0 || ctx.exchangeRate === 0) return true
const newFiatCents = ctx.fiatCents + denomination * 100
const grossSats = Math.floor((newFiatCents / 100) * ctx.exchangeRate)
const fee = Math.floor(grossSats * ctx.feePercent)
return grossSats - fee <= ctx.availableBalance
const principalSats = Math.floor((newFiatCents / 100) * ctx.exchangeRate)
const fee = Math.floor(principalSats * ctx.feePercent)
return principalSats - fee <= ctx.availableBalance
}
const balanceLimitReached = computed(() => {