Skip to content

Upgrading versions

This page provides some tips of how to upgrade between versions.

v0.7.4 to v0.7.5

No backwards incompatible changes for skill and connection development.

v0.7.3 to v0.7.4

No backwards incompatible changes for skill and connection development.

v0.7.2 to v0.7.3

No backwards incompatible changes for skill and connection development.

v0.7.1 to v0.7.2

No backwards incompatible changes for skill and connection development.

v0.7.0 to v0.7.1

To improve performance, in particular optimize memory usage, we refactored the Message and Dialogue classes. This means all protocols need to be bumped to the latest version or regenerated using the generate command.

v0.6.3 to v0.7.0

Multiple breaking changes require action in this order:

  • Custom configuration overrides in aea-config.yaml are now identified via public_id rather than author, name and version individually. Please replace the three fields with the equivalent public_id.

  • Run aea upgrade command to upgrade your project's dependencies. Note, you still do have to manually update the public ids under default_routing and default_connection in aea-config.yaml as well as the public ids in the non-vendor packages.

  • Previously, connection fetchai/stub, skill fetchai/error and protocols fetchai/default, fetchai/signing and fetchai/state_update where part of the AEA distribution. Now they need to be fetched from registry. If you create a new project with aea create then this happens automatically. For existing projects, add the dependencies explicitly if not already present. You also must update the import paths as follows:

    • aea.connections.stub > packages.fetchai.connections.stub
    • aea.protocols.default > packages.fetchai.protocols.default
    • aea.protocols.signing > packages.fetchai.protocols.signing
    • aea.protocols.state_update > packages.fetchai.protocols.state_update
    • aea.skills.error > packages.fetchai.skills.error
  • If you use custom protocols, regenerate them.

  • In your own skills' __init__.py files add the public id (updating the string as appropriate):

from aea.configurations.base import PublicId


PUBLIC_ID = PublicId.from_str("author/name:0.1.0")
- The fetchai/http protocol's bodyy field has been renamed to body.

  • Skills can now specify connections as dependencies in the config yaml.

v0.6.2 to v0.6.3

A new upgrade command is introduced to upgrade agent projects and components to their latest versions on the registry. To use the command first upgrade the AEA PyPI package to the latest version, then enter your project and run aea upgrade. The project's vendor dependencies will be updated where possible.

v0.6.1 to v0.6.2

No public APIs have been changed.

v0.6.0 to v0.6.1

The soef connection and oef_search protocol have backward incompatible changes.

v0.5.4 to v0.6.0

Dialogue and Dialogues API updates

The dialogue and dialogues APIs have changed significantly. The constructor is different for both classes and there are now four primary methods for the developer:

  • Dialogues.create: this method is used to create a new dialogue and message:

    cfp_msg, fipa_dialogue = fipa_dialogues.create(
        counterparty=opponent_address,
        performative=FipaMessage.Performative.CFP,
        query=query,
    )
    
    The method will raise if the provided arguments are inconsistent.

  • Dialogues.create_with_message: this method is used to create a new dialogue from a message:

    fipa_dialogue = fipa_dialogues.create_with_message(
        counterparty=opponent_address,
        initial_message=cfp_msg
    )
    
    The method will raise if the provided arguments are inconsistent.

  • Dialogues.update: this method is used to handle messages passed by the framework:

    fipa_dialogue = fipa_dialogues.update(
        message=cfp_msg
    )
    
    The method will return a valid dialogue if it is a valid message, otherwise it will return None.

  • Dialogue.reply: this method is used to reply within a dialogue:

    proposal_msg = fipa_dialogue.reply(
        performative=FipaMessage.Performative.PROPOSE,
        target_message=cfp_msg,
        proposal=proposal,
    )
    
    The method will raise if the provided arguments are inconsistent.

The new methods significantly reduce the lines of code needed to maintain a dialogue. They also make it easier for the developer to construct valid dialogues and messages.

FetchAICrypto - default crypto

The FetchAICrypto has been upgraded to the default crypto. Update your default_ledger to fetchai.

Private key file naming

The private key files are now consistenly named with the ledger_id followed by _private_key.txt (e.g. fetchai_private_key.txt). Rename your existing files to match this pattern.

Type in package yaml

The package yamls now contain a type field. This must be added for the loading mechanism to work properly.

Moved address type

The address type has moved to aea.common. The import paths must be updated.

v0.5.3 to v0.5.4

The contract base class was slightly modified. If you have implemented your own contract package you need to update it accordingly.

The dialogue reference nonce is now randomly generated. This can result in previously working but buggy implementations (which relied on the order of dialogue reference nonces) to now fail.

v0.5.2 to v0.5.3

Connection states and logger usage in connections where updated. If you have implemented your own connection package you need to update it accordingly.

Additional dialogue consistency checks where enabled. This can result in previously working but buggy implementations to now fail.

v0.5.1 to 0.5.2

No public APIs have been changed.

v0.5.0 to 0.5.1

No public APIs have been changed.

v0.4.1 to 0.5.0

A number of breaking changes where introduced which make backwards compatibility of skills rare.

  • Ledger apis LedgerApis have been removed from the AEA constructor and skill context. LedgerApis are now exposed in the LedgerConnection (fetchai/ledger). To communicate with the LedgerApis use the fetchai/ledger_api protocol. This allows for more flexibility (anyone can add another LedgerAPI to the registry and execute it with the connection) and removes dependencies from the core framework.
  • Skills can now depend on other skills. As a result, skills have a new required config field in skill.yaml files, by default empty: skills: [].

v0.4.0 to v0.4.1

There are no upgrage requirements if you use the CLI based approach to AEA development.

Connections are now added via Resources to the AEA, not the AEA constructor directly. For programmatic usage remove the list of connections from the AEA constructor and instead add the connections to resources.

v0.3.3 to v0.4.0

  • Message sending in the skills has been updated. In the past you had to construct messages, then serialize them and place them in an envelope:
    cfp_msg = FipaMessage(...)
    self.context.outbox.put_message(
        to=opponent_addr,
        sender=self.context.agent_address,
        protocol_id=FipaMessage.protocol_id,
        message=FipaSerializer().encode(cfp_msg),
    )
    # or
    cfp_msg = FipaMessage(...)
    envelope = Envelope(
        to=opponent_addr,
        sender=self.context.agent_address,
        protocol_id=FipaMessage.protocol_id,
        message=FipaSerializer().encode(cfp_msg),
    )
    self.context.outbox.put(envelope)
    
    Now this has been simplified to:
    cfp_msg = FipaMessage(...)
    cfp_msg.counterparty = opponent_addr
    self.context.outbox.put_message(message=cfp_msg)
    
    You must update your skills as the old implementation is no longer supported.
  • Connection constructors have been simplified. In the past you had to implement both the `__init__` as well as the `from_config` methods of a Connection. Now you only have to implement the `__init__` method which by default at load time now receives the following kwargs: `configuration: ConnectionConfig, identity: Identity, crypto_store: CryptoStore`. See for example in the scaffold connection:
    class MyScaffoldConnection(Connection):
        """Proxy to the functionality of the SDK or API."""
    
        connection_id = PublicId.from_str("fetchai/scaffold:0.1.0")
    
        def __init__(
            self,
            configuration: ConnectionConfig,
            identity: Identity,
            crypto_store: CryptoStore,
        ):
            """
            Initialize a connection to an SDK or API.
    
            :param configuration: the connection configuration.
            :param crypto_store: object to access the connection crypto objects.
            :param identity: the identity object.
            """
            super().__init__(
                configuration=configuration, crypto_store=crypto_store, identity=identity
            )
    
    As a result of this feature, you are now able to pass key-pairs to your connections via the `CryptoStore`. You must update your connections as the old implementation is no longer supported.