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

feat: add avail plugin #1241

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

feat: add avail plugin #1241

wants to merge 9 commits into from

Conversation

robin-rrt
Copy link

Relates to:

N/A

Risks

Low.
The main implementation risk is that the Plugin doesn't work as intended.

Background

What does this PR do?

Avail aims to accelerate Web3's unification using its cutting-edge modular technology stack, which combines data availability, aggregation, and shared security.

In this version, the transfer and submitData actions are supported.

Multiple L2s are working with Avail to meet their data availability and interoperability needs.

What kind of change is this?

Features (non-breaking change which adds functionality)

Documentation changes needed?

Since Avail is a Substrate based network, and not EVM-compatible (cannot work with plugin-evm), it requires some docs to show how to submit data and transfer tokens. I have updated the documentation accordingly in the README for the plugin.

Testing

Where should a reviewer start?

Most of the changes are in plugin-avail

Detailed testing steps

  • In .env you should set the value for AVAIL_ADDRESS (this is the public address for the agent account) and AVAIL_SEED (seed phrase for the same account).
  • Transfer AVAIL
    • To test transfer function, you need tokens in your Avail account. On testnet, you can use the Avail Faucet. If you need more please ping me, and I can send it over.
    • Run the agent and prompt it with: "send 1 AVAIL to " - e.g. send 1 AVAIL to 5GWbvXjefEvXXETtKQH7YBsUaPc379KAQATW1eqeJT26cbsK
    • Assuming everything goes smoothly the agent returns with the Tx Hash, and Block Hash.
      The tx hash can be checked on the Avail block explorer at https://avail-turing.subscan.io/
  • Submit Data
    • To test data submission, you need tokens in your Avail account to pay fees. On testnet, you can use the Avail Faucet. If you need more please ping me, and I can send it over.
    • Run the agent and prompt it with: "Submit the following data to Avail " - e.g. Submit the following data to Avail "Hello World!"
    • Assuming everything goes smoothly the agent returns with the Tx Hash, and Block Hash.

Discord username

RobinRRT

@robin-rrt robin-rrt changed the title Add plugin for Avail feat: add avail plugin Dec 19, 2024
agent/src/index.ts Show resolved Hide resolved
@odilitime odilitime added Plugin_new Mark PRs that are a new plugin needs_documentation labels Dec 20, 2024
@robin-rrt
Copy link
Author

@odilitime what documentation would you like to see more for the plugin? I see you put a tag for more documentation

@robin-rrt
Copy link
Author

@odilitime addressed changes. please review

@robin-rrt robin-rrt requested a review from odilitime December 21, 2024 16:18
@robin-rrt
Copy link
Author

Hey @odilitime checking in if you please review and merge the plugin

@odilitime
Copy link
Collaborator

You don’t need to do the docs, the label is for our docs team. Though have a README.md in the root of the plugin explaining what it does and what settings are available is always helpful.

please work on your conflicts and we’ll look at merging it Monday

@robin-rrt
Copy link
Author

@odilitime conflicts must be solved now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs_documentation Plugin_new Mark PRs that are a new plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants