Struct Transfer

pub struct Transfer {
    pub asset: AssetId,
    pub originator: Participant,
    pub beneficiary: Option<Participant>,
    pub amount: String,
    pub agents: Vec<Participant>,
    pub memo: Option<String>,
    pub settlement_id: Option<String>,
    pub transaction_id: String,
    pub metadata: HashMap<String, Value>,
}

Transfer message body (TAIP-3).

Fields

asset: AssetId

Network asset identifier (CAIP-19 format).

originator: Participant

Originator information.

beneficiary: Option<Participant>

Beneficiary information (optional).

amount: String

Transfer amount.

agents: Vec<Participant>

Agents involved in the transfer.

memo: Option<String>

Memo for the transfer (optional).

settlement_id: Option<String>

Settlement identifier (optional).

transaction_id: String

Transaction identifier (not stored in the struct but accessible via the TapMessage trait).

metadata: HashMap<String, Value>

Additional metadata for the transfer.

Implementations

impl Transfer

pub fn builder() -> TransferBuilder

Create a new Transfer

Example

use tap_msg::message::Transfer;
use tap_caip::{AssetId, ChainId};
use tap_msg::message::Participant;
use std::collections::HashMap;

// Create chain ID and asset ID
let chain_id = ChainId::new("eip155", "1").unwrap();
let asset = AssetId::new(chain_id, "erc20", "0x6b175474e89094c44da98b954eedeac495271d0f").unwrap();

// Create participant
let originator = Participant {
    id: "did:example:alice".to_string(),
    role: Some("originator".to_string()),
    policies: None,
    leiCode: None,
};

// Create a transfer with required fields
let transfer = Transfer::builder()
    .asset(asset)
    .originator(originator)
    .amount("100".to_string())
    .build();

pub fn message_id(&self) -> String

Generates a unique message ID for authorization, rejection, or settlement

pub fn validate(&self) -> Result<()>

Validate the Transfer

Trait Implementations

impl Authorizable for Transfer

Implementation of Authorizable for Transfer

fn authorize(&self, note: Option<String>) -> Authorize

Authorizes this message, creating an Authorize message as a response

Arguments

• note - Optional note

Returns

A new Authorize message body

fn confirm_relationship( &self, transaction_id: String, agent_id: String, for_id: String, role: Option<String>, ) -> ConfirmRelationship

Confirms a relationship between agents, creating a ConfirmRelationship message as a response

Arguments

• transfer_id - ID of the transfer related to this message
• agent_id - DID of the agent whose relationship is being confirmed
• for_id - DID of the entity that the agent acts on behalf of
• role - Optional role of the agent in the transaction

Returns

A new ConfirmRelationship message body

fn reject(&self, code: String, description: String) -> Reject

Rejects this message, creating a Reject message as a response

Arguments

• code - Rejection code
• description - Description of rejection reason

Returns

A new Reject message body

fn settle(&self, settlement_id: String, amount: Option<String>) -> Settle

Settles this message, creating a Settle message as a response

Arguments

• settlement_id - Settlement ID (CAIP-220 identifier)
• amount - Optional amount settled

Returns

A new Settle message body

fn update_party( &self, transaction_id: String, party_type: String, party: Participant, note: Option<String>, ) -> UpdateParty

Updates a party in the transaction, creating an UpdateParty message as a response

Arguments

• transfer_id - ID of the transaction this update relates to
• party_type - Type of party being updated (e.g., ‘originator’, ‘beneficiary’)
• party - Updated party information
• note - Optional note about the update

Returns

A new UpdateParty message body

fn update_policies( &self, transaction_id: String, policies: Vec<Policy>, ) -> UpdatePolicies

Updates policies for this message, creating an UpdatePolicies message as a response

Arguments

• transaction_id - ID of the transaction being updated
• policies - Vector of policies to be applied

Returns

A new UpdatePolicies message body

fn add_agents( &self, transaction_id: String, agents: Vec<Participant>, ) -> AddAgents

Adds agents to this message, creating an AddAgents message as a response

Arguments

• transaction_id - ID of the transaction to add agents to
• agents - Vector of participants to be added

Returns

A new AddAgents message body

fn replace_agent( &self, transaction_id: String, original: String, replacement: Participant, ) -> ReplaceAgent

Replaces an agent in this message, creating a ReplaceAgent message as a response

Arguments

• transaction_id - ID of the transaction to replace agent in
• original - DID of the original agent to be replaced
• replacement - New participant replacing the original agent

Returns

A new ReplaceAgent message body

fn remove_agent(&self, transaction_id: String, agent: String) -> RemoveAgent

Removes an agent from this message, creating a RemoveAgent message as a response

Arguments

• transaction_id - ID of the transaction to remove agent from
• agent - DID of the agent to remove

Returns

A new RemoveAgent message body

impl Clone for Transfer

fn clone(&self) -> Transfer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Connectable for Transfer

fn with_connection(&mut self, connect_id: &str) -> &mut Self

Connect this message to a prior Connect message by setting the parent thread ID (pthid).

fn has_connection(&self) -> bool

Check if this message is connected to a prior Connect message.

fn connection_id(&self) -> Option<&str>

Get the connection ID if present.

impl Debug for Transfer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transfer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Transfer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapMessage for Transfer

fn validate(&self) -> Result<()>

Validates a TAP message.

fn is_tap_message(&self) -> bool

Checks if this message is a TAP message.

fn get_tap_type(&self) -> Option<String>

Gets the TAP message type from this message.

fn body_as<T: TapMessageBody>(&self) -> Result<T>

Extract a specific message body type from this message.

fn get_all_participants(&self) -> Vec<String>

Get all participant DIDs from this message.

fn create_reply<T: TapMessageBody>( &self, body: &T, creator_did: &str, ) -> Result<Message>

Create a reply to this message.

fn message_type(&self) -> &'static str

Get the message type for this message

fn thread_id(&self) -> Option<&str>

Get the thread ID for this message

fn parent_thread_id(&self) -> Option<&str>

Get the parent thread ID for this message

fn message_id(&self) -> &str

Get the message ID for this message

impl TapMessageBody for Transfer

fn message_type() -> &'static str

Get the message type string for this body type.

fn validate(&self) -> Result<()>

Validate the message body.

fn to_didcomm(&self, from_did: Option<&str>) -> Result<Message>

Convert this body to a DIDComm message.

fn to_didcomm_with_route<'a, I>( &self, from: Option<&str>, to: I, ) -> Result<Message>

where I: IntoIterator<Item = &'a str>,

Convert this body to a DIDComm message with a sender and multiple recipients.

fn from_didcomm(message: &Message) -> Result<Self>

where Self: Sized,

Extract this body type from a DIDComm message.