fix(ledger): reject posting sets that overflow the zero-sum check
An adversarial posting set of two MaxInt64 legs plus one of 2 wraps to zero in int64 arithmetic, so the balance check passed and the ledger minted 18 quintillion millisatoshis from nothing. The sum is now accumulated in big.Int, per-account balance arithmetic is checked for wraparound, and the audit totals parse through big.Int so a corrupt ledger reports a clear error rather than failing to scan. Adds room package tests (0% -> covered) and ledger edge cases. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
232
pkg/ledger/edge_test.go
Normal file
232
pkg/ledger/edge_test.go
Normal file
@@ -0,0 +1,232 @@
|
||||
package ledger_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"math"
|
||||
"sync"
|
||||
"testing"
|
||||
|
||||
"github.com/drjones/quantum-arcade/pkg/ledger"
|
||||
)
|
||||
|
||||
// These tests attack the ledger with extreme values. Money code fails at the
|
||||
// boundaries, so the boundaries are where it should be hit hardest.
|
||||
|
||||
func TestHugeBalanceIsExact(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
p, err := l.EnsurePlayer(ctx, uniqueKey(t, "whale"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
// 21 million BTC in millisatoshis is the largest amount that can ever
|
||||
// exist: 2.1e15. It must round-trip exactly, with no float contamination.
|
||||
const allTheBitcoin int64 = 21_000_000 * 100_000_000 * 1000
|
||||
if _, err := l.Deposit(ctx, p, allTheBitcoin); err != nil {
|
||||
t.Fatalf("depositing the entire supply: %v", err)
|
||||
}
|
||||
bal, err := l.Balance(ctx, p)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if bal != allTheBitcoin {
|
||||
t.Fatalf("balance = %d, want %d (off by %d)", bal, allTheBitcoin, bal-allTheBitcoin)
|
||||
}
|
||||
}
|
||||
|
||||
// A deposit that would overflow int64 must be refused, not wrap around.
|
||||
func TestOverflowingDepositIsRejected(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
p, _ := l.EnsurePlayer(ctx, uniqueKey(t, "overflow"))
|
||||
|
||||
// A MaxInt64 deposit must be refused: it would underflow the bridge, whose
|
||||
// balance is already negative by everything owed to players.
|
||||
if _, err := l.Deposit(ctx, p, math.MaxInt64); err == nil {
|
||||
t.Fatal("a MaxInt64 deposit was accepted")
|
||||
}
|
||||
if bal, _ := l.Balance(ctx, p); bal != 0 {
|
||||
t.Fatalf("rejected deposit still moved the balance to %d", bal)
|
||||
}
|
||||
}
|
||||
|
||||
// Credit overflow is structurally unreachable, and that is a stronger
|
||||
// guarantee than the runtime guard.
|
||||
//
|
||||
// Every millisatoshi inside the system was issued by debiting the bridge, and
|
||||
// the bridge cannot pass MinInt64. So the sum of all non-bridge balances is
|
||||
// bounded by MaxInt64, and no individual account can be pushed past it by any
|
||||
// sequence of balanced transactions. The guard in Post remains as defence in
|
||||
// depth against a future issuance path that does not go through the bridge.
|
||||
func TestIssuanceIsBoundedByTheBridge(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
p, _ := l.EnsurePlayer(ctx, uniqueKey(t, "bounded"))
|
||||
|
||||
// Attempting to issue more than the bridge can back must fail.
|
||||
if _, err := l.Deposit(ctx, p, math.MaxInt64); err == nil {
|
||||
t.Fatal("issued more than the bridge can back")
|
||||
}
|
||||
|
||||
// And whatever has been issued must still fit in an int64, which is what
|
||||
// makes every downstream balance arithmetic safe.
|
||||
issued, err := l.TotalIssued(ctx)
|
||||
if err != nil {
|
||||
t.Fatalf("total issuance is no longer representable: %v", err)
|
||||
}
|
||||
if issued < 0 {
|
||||
t.Fatalf("total issued is negative: %d", issued)
|
||||
}
|
||||
}
|
||||
|
||||
// Postings that individually fit but collectively overflow the zero-sum check.
|
||||
func TestOverflowingPostingSetIsRejected(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
a, _ := l.EnsurePlayer(ctx, uniqueKey(t, "a"))
|
||||
b, _ := l.EnsurePlayer(ctx, uniqueKey(t, "b"))
|
||||
c, _ := l.EnsurePlayer(ctx, uniqueKey(t, "c"))
|
||||
|
||||
// These sum to zero only if you ignore wraparound.
|
||||
_, err := l.Post(ctx, "attack", nil, []ledger.Posting{
|
||||
{AccountID: a, AmountMsat: math.MaxInt64},
|
||||
{AccountID: b, AmountMsat: math.MaxInt64},
|
||||
{AccountID: c, AmountMsat: 2},
|
||||
})
|
||||
if err == nil {
|
||||
t.Fatal("a posting set that overflows int64 was accepted")
|
||||
}
|
||||
}
|
||||
|
||||
func TestSmallestPossibleAmount(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
p, _ := l.EnsurePlayer(ctx, uniqueKey(t, "dust"))
|
||||
|
||||
if _, err := l.Deposit(ctx, p, 1); err != nil {
|
||||
t.Fatalf("one millisatoshi rejected: %v", err)
|
||||
}
|
||||
if bal, _ := l.Balance(ctx, p); bal != 1 {
|
||||
t.Fatalf("balance = %d, want 1", bal)
|
||||
}
|
||||
// Spending exactly the balance must leave zero, not fail.
|
||||
q, _ := l.EnsurePlayer(ctx, uniqueKey(t, "dust2"))
|
||||
if _, err := l.Transfer(ctx, p, q, 1); err != nil {
|
||||
t.Fatalf("spending the exact balance failed: %v", err)
|
||||
}
|
||||
if bal, _ := l.Balance(ctx, p); bal != 0 {
|
||||
t.Fatalf("balance = %d after spending everything, want 0", bal)
|
||||
}
|
||||
}
|
||||
|
||||
// Spending one millisatoshi more than you hold must fail, at every scale.
|
||||
func TestOffByOneOverdraftAtEveryScale(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
|
||||
for _, amount := range []int64{1, 1000, 1_000_000, 100_000_000_000} {
|
||||
p, _ := l.EnsurePlayer(ctx, uniqueKey(t, "scale"+itoa(amount)))
|
||||
q, _ := l.EnsurePlayer(ctx, uniqueKey(t, "scaledst"+itoa(amount)))
|
||||
if _, err := l.Deposit(ctx, p, amount); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := l.Transfer(ctx, p, q, amount+1); err == nil {
|
||||
t.Fatalf("overdraft by 1 accepted at scale %d", amount)
|
||||
}
|
||||
if _, err := l.Transfer(ctx, p, q, amount); err != nil {
|
||||
t.Fatalf("exact-balance transfer rejected at scale %d: %v", amount, err)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Hammer one account from many goroutines and confirm not a single
|
||||
// millisatoshi is created or lost.
|
||||
func TestHighContentionConservesExactly(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
|
||||
hub, _ := l.EnsurePlayer(ctx, uniqueKey(t, "hub"))
|
||||
if _, err := l.Deposit(ctx, hub, 1_000_000); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
const workers = 16
|
||||
spokes := make([]int64, workers)
|
||||
for i := range spokes {
|
||||
spokes[i], _ = l.EnsurePlayer(ctx, uniqueKey(t, "spoke"+itoa(int64(i))))
|
||||
}
|
||||
|
||||
var wg sync.WaitGroup
|
||||
for i := 0; i < workers; i++ {
|
||||
wg.Add(1)
|
||||
go func(i int) {
|
||||
defer wg.Done()
|
||||
for j := 0; j < 20; j++ {
|
||||
// Push out and pull back; net zero if nothing is lost.
|
||||
if _, err := l.Transfer(ctx, hub, spokes[i], 137); err == nil {
|
||||
_, _ = l.Transfer(ctx, spokes[i], hub, 137)
|
||||
}
|
||||
}
|
||||
}(i)
|
||||
}
|
||||
wg.Wait()
|
||||
|
||||
total := int64(0)
|
||||
for _, id := range spokes {
|
||||
bal, err := l.Balance(ctx, id)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
total += bal
|
||||
}
|
||||
hubBal, err := l.Balance(ctx, hub)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if total+hubBal != 1_000_000 {
|
||||
t.Fatalf("value changed under contention: %d, want 1000000", total+hubBal)
|
||||
}
|
||||
}
|
||||
|
||||
// Self-transfers must not mint money through double-counting the same account.
|
||||
func TestSelfTransferDoesNotMint(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
p, _ := l.EnsurePlayer(ctx, uniqueKey(t, "self"))
|
||||
if _, err := l.Deposit(ctx, p, 10_000); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
_, _ = l.Transfer(ctx, p, p, 5_000)
|
||||
|
||||
bal, err := l.Balance(ctx, p)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if bal != 10_000 {
|
||||
t.Fatalf("self-transfer changed balance to %d, want 10000", bal)
|
||||
}
|
||||
}
|
||||
|
||||
func itoa(v int64) string {
|
||||
if v == 0 {
|
||||
return "0"
|
||||
}
|
||||
neg := v < 0
|
||||
if neg {
|
||||
v = -v
|
||||
}
|
||||
var buf [24]byte
|
||||
i := len(buf)
|
||||
for v > 0 {
|
||||
i--
|
||||
buf[i] = byte('0' + v%10)
|
||||
v /= 10
|
||||
}
|
||||
if neg {
|
||||
i--
|
||||
buf[i] = '-'
|
||||
}
|
||||
return string(buf[i:])
|
||||
}
|
||||
@@ -13,6 +13,7 @@ import (
|
||||
"context"
|
||||
"errors"
|
||||
"fmt"
|
||||
"math/big"
|
||||
"sort"
|
||||
"time"
|
||||
|
||||
@@ -57,12 +58,16 @@ func (l *Ledger) Post(ctx context.Context, kind string, roundID *int64, postings
|
||||
if len(postings) == 0 {
|
||||
return 0, ErrEmptyTransaction
|
||||
}
|
||||
var sum int64
|
||||
// The zero-sum check must be overflow-safe. Accumulating into an int64
|
||||
// lets a crafted posting set wrap to zero — two legs of MaxInt64 and one
|
||||
// of 2 sum to 0 in wrapping arithmetic — which would mint money out of
|
||||
// nothing. big.Int has no such boundary.
|
||||
sum := new(big.Int)
|
||||
for _, p := range postings {
|
||||
sum += p.AmountMsat
|
||||
sum.Add(sum, big.NewInt(p.AmountMsat))
|
||||
}
|
||||
if sum != 0 {
|
||||
return 0, fmt.Errorf("%w: sum is %d", ErrUnbalanced, sum)
|
||||
if sum.Sign() != 0 {
|
||||
return 0, fmt.Errorf("%w: sum is %s", ErrUnbalanced, sum.String())
|
||||
}
|
||||
|
||||
tx, err := l.pool.Begin(ctx)
|
||||
@@ -102,7 +107,14 @@ func (l *Ledger) Post(ctx context.Context, kind string, roundID *int64, postings
|
||||
return 0, fmt.Errorf("reading balance of account %d: %w", p.AccountID, err)
|
||||
}
|
||||
|
||||
// Detect wraparound before trusting the result: a credit that
|
||||
// overflows would otherwise land as a negative balance, and a debit
|
||||
// that underflows as a positive one.
|
||||
after := before + p.AmountMsat
|
||||
if (p.AmountMsat > 0 && after < before) || (p.AmountMsat < 0 && after > before) {
|
||||
return 0, fmt.Errorf("ledger: amount %d overflows the balance of account %d (%d)",
|
||||
p.AmountMsat, p.AccountID, before)
|
||||
}
|
||||
if after < 0 && !allowNegative {
|
||||
return 0, fmt.Errorf("%w: account %d holds %d, needs %d",
|
||||
ErrInsufficientFunds, p.AccountID, before, -p.AmountMsat)
|
||||
@@ -227,21 +239,37 @@ func (l *Ledger) AccountByName(ctx context.Context, name string) (int64, error)
|
||||
// every account except the external Lightning bridge. It changes only when
|
||||
// funds genuinely enter or leave, never through internal play.
|
||||
func (l *Ledger) TotalIssued(ctx context.Context) (int64, error) {
|
||||
var total int64
|
||||
err := l.pool.QueryRow(ctx,
|
||||
`SELECT COALESCE(SUM(b.balance_msat), 0)
|
||||
FROM account_balances b
|
||||
JOIN accounts a ON a.id = b.account_id
|
||||
WHERE NOT a.allow_negative`).Scan(&total)
|
||||
return total, err
|
||||
return l.sumBalances(ctx, `WHERE NOT a.allow_negative`)
|
||||
}
|
||||
|
||||
// ConservationCheck sums every account including the bridge. Because each
|
||||
// transaction sums to zero, this must always be exactly zero. A non-zero
|
||||
// result means the books are corrupt, and is the top-level audit alarm.
|
||||
func (l *Ledger) ConservationCheck(ctx context.Context) (int64, error) {
|
||||
var total int64
|
||||
err := l.pool.QueryRow(ctx,
|
||||
`SELECT COALESCE(SUM(balance_msat), 0) FROM account_balances`).Scan(&total)
|
||||
return total, err
|
||||
return l.sumBalances(ctx, ``)
|
||||
}
|
||||
|
||||
// sumBalances totals account balances.
|
||||
//
|
||||
// Postgres SUM() over bigint returns numeric, which can exceed int64 even
|
||||
// though no single balance can. Scanning it as text and parsing through
|
||||
// big.Int means a corrupt ledger reports a clear error instead of a scan
|
||||
// failure — the alarm must survive the very condition it exists to detect.
|
||||
func (l *Ledger) sumBalances(ctx context.Context, where string) (int64, error) {
|
||||
var text string
|
||||
err := l.pool.QueryRow(ctx,
|
||||
`SELECT COALESCE(SUM(b.balance_msat), 0)::text
|
||||
FROM account_balances b
|
||||
JOIN accounts a ON a.id = b.account_id `+where).Scan(&text)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
total, ok := new(big.Int).SetString(text, 10)
|
||||
if !ok {
|
||||
return 0, fmt.Errorf("ledger: unparseable balance total %q", text)
|
||||
}
|
||||
if !total.IsInt64() {
|
||||
return 0, fmt.Errorf("ledger: balance total %s exceeds int64; the books are corrupt", text)
|
||||
}
|
||||
return total.Int64(), nil
|
||||
}
|
||||
|
||||
@@ -16,10 +16,17 @@ func TestRandomActivityConservesValue(t *testing.T) {
|
||||
l := ledger.New(testPool(t))
|
||||
ctx := context.Background()
|
||||
|
||||
house, err := l.AccountByName(ctx, "house_pot")
|
||||
// The test uses its own counterparty rather than the shared house account,
|
||||
// and sums only its own accounts. Asserting on a global total would fail
|
||||
// whenever another package's tests run against the same database in
|
||||
// parallel — a broken test, not a broken ledger.
|
||||
house, err := l.EnsurePlayer(ctx, uniqueKey(t, "counterparty"))
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if _, err := l.Deposit(ctx, house, 5_000_000); err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
const players = 8
|
||||
ids := make([]int64, players)
|
||||
@@ -34,11 +41,22 @@ func TestRandomActivityConservesValue(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
before, err := l.TotalIssued(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
// sumOwn totals only the accounts this test created.
|
||||
sumOwn := func() int64 {
|
||||
t.Helper()
|
||||
var total int64
|
||||
for _, id := range append(append([]int64{}, ids...), house) {
|
||||
bal, err := l.Balance(ctx, id)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
total += bal
|
||||
}
|
||||
return total
|
||||
}
|
||||
|
||||
before := sumOwn()
|
||||
|
||||
rng := rand.New(rand.NewSource(1))
|
||||
roundID := int64(0)
|
||||
for i := 0; i < 400; i++ {
|
||||
@@ -75,11 +93,7 @@ func TestRandomActivityConservesValue(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
after, err := l.TotalIssued(ctx)
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
if before != after {
|
||||
if after := sumOwn(); before != after {
|
||||
t.Fatalf("value not conserved: %d -> %d", before, after)
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user