Skip to content

aea.identity.base

This module contains the identity class.

Identity Objects

class Identity()

The identity holds the public elements identifying an agent.

It includes:

  • the agent name
  • the addresses, a map from address identifier to address (can be a single key-value pair)

__init__

 | __init__(name: SimpleIdOrStr, address: Optional[str] = None, public_key: Optional[str] = None, addresses: Optional[Dict[str, Address]] = None, public_keys: Optional[Dict[str, str]] = None, default_address_key: str = DEFAULT_LEDGER) -> None

Instantiate the identity.

Arguments:

  • name: the name of the agent.
  • address: the default address of the agent.
  • public_key: the public key of the agent.
  • addresses: the addresses of the agent.
  • public_keys: the public keys of the agent.
  • default_address_key: the key for the default address.

default_address_key

 | @property
 | default_address_key() -> str

Get the default address key.

name

 | @property
 | name() -> str

Get the agent name.

addresses

 | @property
 | addresses() -> Dict[str, Address]

Get the addresses.

address

 | @property
 | address() -> Address

Get the default address.

public_keys

 | @property
 | public_keys() -> Dict[str, str]

Get the public keys.

public_key

 | @property
 | public_key() -> str

Get the default public key.