Struct Agent

pub struct Agent {
    pub id: String,
    pub role: String,
    pub for_parties: ForParties,
    pub policies: Option<Vec<Policy>>,
    pub metadata: HashMap<String, Value>,
}

Agent in a transaction (TAIP-5).

Agents are identified using Decentralized Identifiers (DIDs) and can be:

• Centralized services (exchanges, custodial wallets)
• End-user software (self-hosted wallets)
• Decentralized protocols (DeFi protocols, bridges)

Fields

id: String

DID of the agent.

role: String

Role of the agent in this transaction (REQUIRED per TAIP-5). Examples: “SettlementAddress”, “SourceAddress”, etc.

for_parties: ForParties

DID or IRI of another Agent or Party that this agent acts on behalf of (REQUIRED per TAIP-5). Can be a single party or multiple parties.

policies: Option<Vec<Policy>>

Policies of the agent according to TAIP-7 (optional).

metadata: HashMap<String, Value>

Additional JSON-LD metadata for the agent. This allows for extensible metadata beyond the core fields.

Implementations

impl Agent

pub fn new(id: &str, role: &str, for_party: &str) -> Self

Create a new agent with the given DID, role, and for_party.

pub fn new_for_parties(id: &str, role: &str, for_parties: Vec<String>) -> Self

Create a new agent with multiple parties.

pub fn with_metadata( id: &str, role: &str, for_party: &str, metadata: HashMap<String, Value>, ) -> Self

Create a new agent with metadata.

pub fn with_policies(self, policies: Vec<Policy>) -> Self

Add policies to this agent.

pub fn add_policy(self, policy: Policy) -> Self

Add a single policy to this agent.

pub fn add_metadata(&mut self, key: String, value: Value)

Add a metadata field to the agent.

pub fn with_metadata_field(self, key: String, value: Value) -> Self

Add metadata using the builder pattern.

pub fn get_metadata(&self, key: &str) -> Option<&Value>

Get a metadata value by key.

pub fn has_role(&self, role: &str) -> bool

Check if this agent has a specific role.

pub fn acts_for(&self, party_id: &str) -> bool

Check if this agent acts for a specific party.

pub fn for_parties(&self) -> &[String]

Get all parties this agent acts for.

pub fn primary_party(&self) -> Option<&str>

Get the first party this agent acts for (for backward compatibility).

pub fn add_for_party(&mut self, party_id: &str)

Add a party this agent acts for.

pub fn set_for_parties(&mut self, parties: Vec<String>)

Set all parties this agent acts for.

Trait Implementations

impl Clone for Agent

fn clone(&self) -> Agent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Agent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Agent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Agent

fn eq(&self, other: &Agent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Agent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TapParticipant for Agent

fn id(&self) -> &str

Get the identifier of this participant

impl StructuralPartialEq for Agent