Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Explicitly Adding uAgent Address Validation Steps to Documentation #925

Open
2 tasks done
yamnihc04 opened this issue Aug 30, 2024 · 1 comment
Open
2 tasks done
Assignees
Labels
c-feature Category: New feature or request

Comments

@yamnihc04
Copy link
Collaborator

Prerequisites

  • I checked the documentation and made sure this feature does not already exist
  • I checked the existing issues to make sure this feature has not already been requested

Feature

To enhance the user experience and ensure that developers can easily validate the proper setup of their uAgents, I suggest including explicit steps in the documentation for validating a uAgent address after creation. This feature will help users confirm that their uAgent is correctly configured and capable of interacting with the Fetch.ai network.

The validation process can include connectivity tests, simple messaging protocols, and checks for network registration. Providing these steps in the documentation will reduce potential setup issues and improve the reliability of agent deployments.

Source: https://fetch.ai/docs/guides/agents/getting-started/getting-uagent-address

I tried below snippet for the proposed suggestion (not necessary to replicate the exact thing):

from uagents import Agent, Context

alice = Agent(name="alice", seed="alice recovery phrase")

@alice.on_message("test_protocol")
async def handle_message(ctx: Context, sender: str, content: str):
    ctx.logger.info(f"Received message from {sender}: {content}")
    ctx.logger.info(f"Message content: {content}")

async def test_message():
    await alice.send(alice.address, "test_protocol", "Hello, Alice!")

Additional Information (Optional)

No response

@jrriehl jrriehl added the c-feature Category: New feature or request label Sep 2, 2024
@jrriehl
Copy link
Contributor

jrriehl commented Sep 2, 2024

Thanks for the suggestion! I'll move this to our main docs repository for further consideration.

@jrriehl jrriehl transferred this issue from fetchai/uAgents Sep 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c-feature Category: New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants