Skip to main content
fromAddress
string
required
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

toAddress
string
required
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

amount
number
required

Amount of the asset transferred as reported by the upstream provider. The unit is not consistent across providers: native SOL transfers are in lamports (minor unit), while SPL token and EVM transfers are in major units. Prefer amountRaw for any value-sensitive logic.

amountRaw
string
required

Raw minor-unit integer string (lamports / wei / smallest unit). Divide by 10 ** metadata.decimals to get the major-unit value. Always present and consistent across providers and chains.

Example:

"3319278"

tokenAddress
string
Maximum string length: 255
Pattern: ^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$
Example:

"An example name"

metadata
object
Last modified on January 21, 2026