Files
f755e1a3a4 feat(bitstamp): EN-1015 add orders + conversions and refactor for production-readiness (#724)
* feat(bitstamp): EN-1015 add orders + conversions and refactor for production-readiness

Adds first-class orders and conversions primitives to the Bitstamp connector and refactors the package along Formance conventions. The HTTP client is split into client/types.go + client/error.go with OpenTelemetry instrumentation and a typed DerivativesUnsupportedError that drives a process-lifetime try-and-skip cache for permission-gated endpoints (my_markets, fees, crypto-transactions). State is moved to opaque cursors with backward-compatible decoders so existing installs keep their watermarks. Payments are now a three-source union (user_transactions + crypto-transactions + withdrawal-requests) with fail-whole-cycle semantics on top-level source errors and log+continue on per-row map errors. Orders reconcile open_orders snapshots with order_status; conversions detect two-asset user_transactions.type=36 (instant buy/sell). Accounts surface the currency ticker as Name; sub-account transfers (types 14/33/35) are modelled as linked PAYOUT/PAYIN pairs correlated via metadata, reflecting Bitstamp's one-API-key-per-account scope. The Temporal task tree nests balances under accounts (Qonto FromPayload pattern) with payments, orders and conversions as independent roots. Install-time enrichment loads markets, my_markets, trading fees and withdrawal fees in parallel via a generic refreshCache[T] helper with TTL. Full transformation logic lives in a dedicated mappers/ subpackage with extensive unit coverage. MAPPINGS.md documents every decision, the error-policy matrix, and the known historical-orders gap.

* fix(bitstamp): address PR #724 CodeRabbit review — evict on order_status error, deterministic enrichment, log levels

Evict retention-expired tracked orders in fetchNextOrders when GetOrderStatus errors out: a stale ID past the 30-day window will keep failing the call indefinitely, growing state unbounded and spamming Error logs every cycle. Log the eviction at Info because the failure is expected for retention-expired entries. Make representative market/trading-fee selection in buildEnrichmentForCurrency deterministic by picking the lexicographically-smallest match on a composite key (CounterCurrency|MarketType for markets, CurrencyPair for fees) to prevent account-metadata flapping if the PSP returns rows reordered between cycles. Downgrade the derivatives-row skip log in fetchNextConversions from Errorf to Infof — it is an expected branch on a spot-only connector, not a fault. Drop a redundant AbsAmount wrap inside an IsZeroAmount call (Sign() already handles negatives natively). Add language tag to a MAPPINGS.md fenced block to satisfy markdownlint. New unit tests cover the eviction-on-error path and lock the deterministic-representative contract via permutation testing.

Co-authored-by: Cursor <[email protected]>

* Remove any cache initializations from Install step, remove useless skip behaviour for crypto-transactions and withdrawals

* Use GET request for my_markets endpoint, and only handle derivative not supported error where likely to occur

* Drastically reduce amount of caching - instead fetch enrichment data only when new accounts are found

* Delay fetch currencies calls until after we know if work needs to be done to reduce unneeded requests in inactive accounts

* Revert changes to balance fetching that made it only fetch balance once

* Import transactions with trailing zeros that exceed the currency's reported precision

* One exclusive decimal amount parser function among different functions

* Allow two orders with the same ID to be present in a slice by combining them into one record with multiple adjustments

* Use CreatedAt to determine order or order adjustments

* Make Orders workflow a child of accounts, and search markets related to the currency of the account

* Enhance metadata returned in orders

* Only save real account IDs related to orders

* Import each order event only once via the source currency

* Regenerate capabilities

* Add paging mechanism and fix expectations about market event IDs

* Export even if account is destination account

* Address coderabbit comments

* Fix comments on workflow header

* Address coderabbit comments regarding models order

* Only use user transactions endpoint to fetch both conversions and payments

* Truncate trailing digits when they exceed the precision bitstamp provided - raw values still preserved in raw payload

---------

Co-authored-by: Cursor <[email protected]>
Co-authored-by: Crimson Thompson <[email protected]>
2026-05-28 08:40:34 +00:00

81 lines
2.5 KiB
Go

package client
import "errors"
// ErrorResponse accepts both Bitstamp envelope shapes that co-exist on
// the v2 API:
//
// - legacy: {"status":"error","reason":"...","code":"API..."}
// - newer: {"code":"API...","message":"..."}
//
// Endpoints may serve either form depending on which microservice
// answers, so the connector tolerates both silently.
type ErrorResponse struct {
Status string `json:"status"`
Reason string `json:"reason"`
Code string `json:"code"`
Msg string `json:"message"`
}
// Message returns the most specific human-readable description
// available on the envelope.
func (e ErrorResponse) Message() string {
switch {
case e.Msg != "":
return e.Msg
case e.Reason != "":
return e.Reason
default:
return e.Code
}
}
// ErrCodeDerivativesUnsupported is the documented Bitstamp error code
// returned when a derivatives-gated endpoint is invoked by a spot-only
// account (or vice-versa).
const ErrCodeDerivativesUnsupported = "API5506"
// DerivativesUnsupportedError is returned by client methods when a
// request hits a derivatives-gated path on a spot-only account. The
// connector is spot-only by design; callers should treat this as an
// empty result rather than propagating it as a failure.
//
// None of the currently-implemented client methods (account_balances,
// user_transactions, currencies, open_orders, order_status) are
// themselves derivatives-gated, so this is preventive plumbing kept
// here so a future contributor extending the surface (e.g. adding
// /api/v2/trade_history/) gets the right behaviour by default.
type DerivativesUnsupportedError struct {
Endpoint string
Message string
}
func (e *DerivativesUnsupportedError) Error() string {
return "bitstamp: derivatives not supported on " + e.Endpoint + ": " + e.Message
}
// IsDerivativesUnsupportedError reports whether err is (or wraps) a
// DerivativesUnsupportedError.
func IsDerivativesUnsupportedError(err error) bool {
var d *DerivativesUnsupportedError
return errors.As(err, &d)
}
// NotFoundError is returned by client methods when the server responds
// with HTTP 404. For account_order_data this typically means the market
// is not available for the authenticated account.
type NotFoundError struct {
Endpoint string
Message string
}
func (e *NotFoundError) Error() string {
return "bitstamp: not found on " + e.Endpoint + ": " + e.Message
}
// IsNotFoundError reports whether err is (or wraps) a NotFoundError.
func IsNotFoundError(err error) bool {
var n *NotFoundError
return errors.As(err, &n)
}