Struct OnchainAddress 

pub struct OnchainAddress {
    pub address: BlockchainAddress,
    pub asset: Asset,
    pub destination_tag: Option<String>,
    pub network: Network,
}

The target of the payment is an onchain address.

JSON schema

{
 "title": "Onchain Address",
 "description": "The target of the payment is an onchain address.",
 "examples": [
   {
     "address": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
     "asset": "usdc",
     "network": "base"
   }
 ],
 "type": "object",
 "required": [
   "address",
   "asset",
   "network"
 ],
 "properties": {
   "address": {
     "description": "The onchain crypto address of the recipient.\n\nExamples:\n- EVM address: 0xabc1234567890abcdef1234567890abcdef123456\n- Solana address: HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT\n- XRP address: rhccc5p23aKiCGFcEqqnjEfLRZ6xEvfy3s\n",
     "allOf": [
       {
         "$ref": "#/components/schemas/BlockchainAddress"
       }
     ]
   },
   "asset": {
     "description": "Asset symbol of the payment received by the recipient.",
     "examples": [
       "btc"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/Asset"
       }
     ]
   },
   "destinationTag": {
     "description": "The destination tag of the onchain address. Destination tags are used by certain networks\n(primarily XRP/Ripple) to identify specific recipients when multiple users share a single address.\nThe tag ensures funds are credited to the correct account within the shared address.\n\nExamples by network:\n- XRP/Ripple: Numeric values like \"1234567890\" or \"123456\"\n- Stellar (XLM): Memos which can be text, ID, or hash format\n\nNote: Most networks (Ethereum, Bitcoin, Solana) do not use destination tags.\n",
     "type": "string"
   },
   "network": {
     "$ref": "#/components/schemas/Network"
   }
 }
}

Fields

address: BlockchainAddress

The onchain crypto address of the recipient.

    Examples:
    - EVM address: 0xabc1234567890abcdef1234567890abcdef123456
    - Solana address: HpabPRRCFbBKSuJr5PdkVvQc85FyxyTWkFM2obBRSvHT
    - XRP address: rhccc5p23aKiCGFcEqqnjEfLRZ6xEvfy3s

asset: Asset

Asset symbol of the payment received by the recipient.

destination_tag: Option<String>

The destination tag of the onchain address. Destination tags are used by certain networks (primarily XRP/Ripple) to identify specific recipients when multiple users share a single address. The tag ensures funds are credited to the correct account within the shared address.

    Examples by network:
    - XRP/Ripple: Numeric values like "1234567890" or "123456"
    - Stellar (XLM): Memos which can be text, ID, or hash format

    Note: Most networks (Ethereum, Bitcoin, Solana) do not use destination tags.

network: Network

Implementations

impl OnchainAddress

pub fn builder() -> OnchainAddress

Trait Implementations

impl Clone for OnchainAddress

fn clone(&self) -> OnchainAddress

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OnchainAddress

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OnchainAddress

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OnchainAddress> for OnchainAddress

fn from(value: &OnchainAddress) -> Self

Converts to this type from the input type.

impl From<OnchainAddress> for OnchainAddress

fn from(value: OnchainAddress) -> Self

Converts to this type from the input type.

impl From<OnchainAddress> for TransferSource

fn from(value: OnchainAddress) -> Self

Converts to this type from the input type.

impl From<OnchainAddress> for TransferTarget

fn from(value: OnchainAddress) -> Self

Converts to this type from the input type.

impl Serialize for OnchainAddress

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<OnchainAddress> for OnchainAddress

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: OnchainAddress) -> Result<Self, ConversionError>

Performs the conversion.