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.

Sign up for GitHub

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

Ship Bagpipes M2 Delivery #14

Merged
merged 3 commits into from
Nov 20, 2024
Merged

Ship Bagpipes M2 Delivery #14

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
241ea3c
ship OAK M2
decentration Aug 26, 2024
c248fda
add docker
decentration Aug 26, 2024
ab0f9f3
Update bagpipes_m2.md
decentration Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion deliveries/bagpipes_m2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Bagpipes USDC (Ethereum): 0x13d3a4dc4eddc79e5f277d4633834ba6ada15a7f
| Number | Deliverable | Specification |
| -----: | ----------- | ------------- |
| 0. | Documentation | Public documentation [https://docs.bagpipes.io/docs/nodes/chainTx](https://docs.bagpipes.io/docs/nodes/chainTx) | |
| 1. | automationPrice and automationTime pallet integration | **Overdelivery, we support every pallet in Turing and Oak. This was really the only way to do it, because the pallets were much more complex than initially imagined, with depply nesting structures, particularly used with XCM.** |
| 1. | automationPrice and automationTime pallet integration | **Overdelivery, we support every pallet in Turing and Oak. This was really the only way to do it, because the pallets were much more complex than initially imagined, with depply nesting structures, particularly used with XCM.** here is bagpipe template for [automationTime](https://alpha.bagpipes.io/#/create/?diagramData=XEtWDwnDY) in a chainTx node. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The claim of “over-delivered” doesn’t seem accurate. We need to stay aligned with the goal of the grant, which is to trigger a swap transaction on Mangata using the automation pallet extrinsics. The claim that “we support every pallet in Turing” wasn’t part of that goal. While the schedule_xcm_task function in your template is correct, the goal is to abstract it, rather than requiring users to manually fill out every field.

I personally couldn’t fill them all out without additional programmatic assistance. Without proper abstraction, it’s difficult for users to interact with these extrinsics effectively. Since the primary goal of your product is to streamline the user experience, this template link doesn’t achieve that.

An alternative approach would be to provide a template link with pre-filled values, so the user only needs to adjust the amount and click submit. Unfortunately, this template link doesn’t meet that expectation either.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the reasons mentioned above, a detailed demo walkthrough page is required in the 0. | Documentation section. The current documentation at https://docs.bagpipes.io/docs/nodes/chainTx is insufficient on its own.

Copy link
Contributor

@flipchan flipchan Nov 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chrisli30 you can read the AutomationTime docs are here:
https://docs.bagpipes.io/docs/scheduletransfer

Try it out here:
https://app.xcmsend.com/#/create/?diagramData=1Ti7jn5lM

Its much easier to use using the custom actions(Abstracted away), documented in the link above

| 2. | Querying | Enable users to query the pallet storage. |
| 3. | Tests | Tests for API and UI |
| 4. | OAK dashboard | A home area for oak paracahin on bagpipes, containing: A growing list of oak templates; How tos. [https://alpha.bagpipes.io/#/pages/Ava](https://alpha.bagpipes.io/#/pages/Ava) |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@decentration could you add a link of the template built for Turing Network time automation in this PR, so I can give it a try?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The first two links on this page, https://alpha.bagpipes.io/#/pages/Ava, are irrelavent and the bottom two are borken. I think we just need links of Bigpipes template scenarios for the Ava Bagpipes Template 1 and Ava Bagpipes Template 2.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ava Community Page: I can (and just did hide) the the "UI Templates". But better is to look at the Ava page as an example page, for adding any templates, descriptions, photos, links, how tos. Anything can be changed if we add a PR to change it.

Expand All @@ -37,6 +37,8 @@ Bagpipes USDC (Ethereum): 0x13d3a4dc4eddc79e5f277d4633834ba6ada15a7f

#### Docker:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs some description. What is this Docker used for?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the readme has been updated, the docker can be used to test the milestone in a self-hosted environment.


If you want to test this release in your local or self-hosted environment, you can run this docker below.

##### Build
`docker build -t xcmsend:v0.3.1 .`

Expand Down
Loading