requestOnRamp

This is the primary method for submitting an on-ramp request — initiating a fiat spend that results in tokens delivered to the specified wallet address.

🔔

After creating the on-ramp request, the user will need to confirm it in their Holyheld app.

🚨

As per security requirements, the user MUST approve the on-ramp request in their Holyheld mobile app within 3 minutes. If the user declines or lets the confirmation expire, the transaction will fail and will not be executed.

Usage

EVM

const data = await holyheldSDK.evm.onRamp.requestOnRamp({
  walletAddress: '0x...',
  tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
  tokenNetwork: Network.ethereum,
  EURAmount: '1',
});

Parameters

Parameter	Type	Required	Description
walletAddress	string	Yes	Destination wallet address that will receive the tokens. Must be a registered, eligible address.
tokenAddress	string	Yes	Contract address of the token to receive.
tokenNetwork	Network	Yes	The chain the token will arrive on.
EURAmount	string	Yes	EUR amount to spend, as a decimal string (e.g. "50" for 50 EUR).

Wallet Address

User's wallet address

• Type: string

EVM

const data = await holyheldSDK.evm.onRamp.requestOnRamp({
  walletAddress: '0x...', 
  tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
  tokenNetwork: Network.ethereum,
  EURAmount: '1',
});

Token Address

Address of the token

• Type: string

EVM

const data = await holyheldSDK.evm.onRamp.requestOnRamp({
  walletAddress: '0x...',
  tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', 
  tokenNetwork: Network.ethereum,
  EURAmount: '1',
});

Token Network

Network where tokens will arrive

• Type: Network

EVM

const data = await holyheldSDK.evm.onRamp.requestOnRamp({
  walletAddress: '0x...',
  tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
  tokenNetwork: Network.ethereum, 
  EURAmount: '1',
});

EUR Amount

EUR amount

• Type: String

EVM

const data = await holyheldSDK.evm.onRamp.requestOnRamp({
  walletAddress: '0x...',
  tokenAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
  tokenNetwork: Network.ethereum,
  EURAmount: '1'
});

Returns

types.ts

type RequestOnRampEVMResult = {
  requestUid: string;
  chainId: number;
  token: TokenEVM;
  amountEUR: string;
  amountToken: string;
  feeEUR: string;
  beneficiaryAddress: EVMAddress;
}

requestUid

ID of the on-ramp request created

• Type: String

types.ts

type RequestOnRampEVMResult = {
  requestUid: string; 
  chainId: number;
  token: TokenEVM;
  amountEUR: string;
  amountToken: string;
  feeEUR: string;
  beneficiaryAddress: EVMAddress;
}

chainId

ID of the network where tokens will arrive

• Type: Number

types.ts

type RequestOnRampEVMResult = {
  requestUid: string;
  chainId: number; 
  token: TokenEVM;
  amountEUR: string;
  amountToken: string;
  feeEUR: string;
  beneficiaryAddress: EVMAddress;
}

token

Token object that will be delivered on success

• Type: TokenEVM

types.ts

type RequestOnRampEVMResult = {
  requestUid: string;
  chainId: number;
  token: TokenEVM; 
  amountEUR: string;
  amountToken: string;
  feeEUR: string;
  beneficiaryAddress: EVMAddress;
}

amountEUR

Amount of EUR charged from the user

• Type: String

types.ts

type RequestOnRampEVMResult = {
  requestUid: string;
  chainId: number;
  token: TokenEVM;
  amountEUR: string; 
  amountToken: string;
  feeEUR: string;
  beneficiaryAddress: EVMAddress;
}

amountToken

Native amount of tokens received

• Type: String

types.ts

type RequestOnRampEVMResult = {
  requestUid: string;
  chainId: number;
  token: TokenEVM;
  amountEUR: string;
  amountToken: string; 
  feeEUR: string;
  beneficiaryAddress: EVMAddress;
}

feeEUR

Network gas fee charged from the total transaction amount

• Type: String

types.ts

type RequestOnRampEVMResult = {
  requestUid: string;
  chainId: number;
  token: TokenEVM;
  amountEUR: string;
  amountToken: string;
  feeEUR: string; 
  beneficiaryAddress: EVMAddress;
}

beneficiaryAddress

User wallet address where tokens will arrive

• Type: string

types.ts

type RequestOnRampEVMResult = {
  requestUid: string;
  chainId: number;
  token: TokenEVM;
  amountEUR: string;
  amountToken: string;
  feeEUR: string;
  beneficiaryAddress: EVMAddress; 
}