SDK References

This section provides a complete reference for all functions available in the BRRR SDK. Functions are grouped into three categories. For step-by-step integration guidance, see the Deposit and Withdraw hubs.

Off-Ramp Functions

These functions facilitate crypto-to-fiat transactions, converting tokens held in a user's wallet into EUR credited to their Holyheld card.

Function	Description
convertTokenToEUR	Convert a token amount to its EUR equivalent at the current rate
convertEURToToken	Convert a EUR amount to the corresponding token amount at the current rate
topup	Execute an off-ramp transaction, sending tokens to a specified Holyheld $holytag
topupSelf	Execute an off-ramp to the Holyheld card of the connected wallet — no $holytag required

On-Ramp Functions

These functions facilitate fiat-to-crypto transactions, converting EUR from the user's Holyheld card into tokens delivered to a wallet address.

Function	Description
convertTokenToEUR	Estimate the EUR value of a token amount for on-ramp display
convertEURToToken	Estimate the token amount for a given EUR input
getOnRampEstimation	Get a full on-ramp estimate including fees and expected token output
requestOnRamp	Initiate an on-ramp request, triggering the fiat-to-crypto conversion
watchRequestId	Poll an on-ramp request until it reaches a terminal status

Common Functions

These functions are not specific to either flow but are required for general SDK operation, address validation, and balance retrieval.

Function	Description
getServerSettings	Fetch current service status and min/max EUR limits for on-ramp and off-ramp
getTagInfo	Look up a Holyheld $holytag to verify it exists and retrieve recipient details
validateAddress	Validate a wallet address and check whether it is eligible for off-ramp and on-ramp
getWalletBalances	Retrieve all supported token balances for a wallet address