Skip to content

feat(platform): add payment cli for streaming payments w/ ApePay #129

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

Merged
merged 15 commits into from
Oct 9, 2024
Merged

feat(platform): add payment cli for streaming payments w/ ApePay #129

Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
b28971a
refactor(cluster): add stream_id to cluster record
fubuloubu Oct 7, 2024
1479dd4
refactor(client): add streaming payment methods to platform client
fubuloubu Oct 7, 2024
07b863e
style(client): make mypy happy
fubuloubu Oct 7, 2024
7d1f9a3
refactor(cli): add some helpful methods
fubuloubu Oct 7, 2024
5b9d17d
feat(cluster): add commands to pay for, add funds to, and cancel streams
fubuloubu Oct 7, 2024
1b670db
feat(cli): add note on how long it takes to deploy, and how to check
fubuloubu Oct 8, 2024
cd9d314
fix(cli): bad variable reference
fubuloubu Oct 8, 2024
e6edef7
feat(cli): add more helpful notes to CLI for payments
fubuloubu Oct 8, 2024
a317a8f
chore(deps): ApePay didn't officially support Py 3.10
fubuloubu Oct 8, 2024
7e9fd68
docs(platform): add docs guide for payments
fubuloubu Oct 8, 2024
93eacd7
fix(typing): switch order of computed_field and property
fubuloubu Oct 8, 2024
b3bebf7
fix(client): revert change ordering of property/computed_filed
fubuloubu Oct 8, 2024
7dbe052
docs(cli): add better note to CLI for cluster pay funding
fubuloubu Oct 8, 2024
5862d44
Merge branch 'main' into feat/payment-cli
johnson2427 Oct 9, 2024
4dd1b33
fix: black and isort
johnson2427 Oct 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
20 changes: 20 additions & 0 deletions docs/userguides/platform.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,23 @@ The Platform UI will let you create and manage Clusters using a graphical experi
The CLI experience is for those working locally who don't want to visit the website, or are locally developing their applications.
```

Once you have created your Cluster, you have to fund it so it is made available for your use.
To do that, use the [`silverback cluster pay create`][silverback-cluster-pay-create] command to fund your newly created cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion(non-blocking): I wonder if it's worth mentioning that you need a funded Ape account for this to work. Might confuse things maybe, but I'm not sure if all Silverback users will have an Ape environment ready to go.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good suggestion!

Yes, the UI will be more hand-holdy through this experience, only so much I can do via CLI without assuming a certain level of experience from the user

Please note that provisioning your cluster will take time, and it may take up to an hour for it to be ready.
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: I think it's safe to lower that expectation a bit to no more than 30 minutes. I can't seem to find my initial reference for some reason, but I thought the AWS docs mentioned up to 15 minutes. And in my experience it hasn't taken that long.

Did you see longer or something?

Copy link
Member Author

Choose a reason for hiding this comment

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

Just leaving space in case we have something slowing it down. In practice I see just under 10 minutes.

But also, the ApePay stream cannot be touched until after 1 hour, which is sort of the hard limit for safety purposes (not allow more changes to the stream parameters while infra changes are occuring)

We can move these parameters inwards later

Copy link
Contributor

Choose a reason for hiding this comment

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

Just seems like we're shouting at the user that "this will be so incredibly slow you'll grow a beard" before they even get to try it. Though at least they'll be pleasantly surprised with a 10 minutes deploy. 😄

Copy link
Member Author

Choose a reason for hiding this comment

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

I think the opposite, if you don't explicitly call out that it is going to take longer than like ~5 seconds or so, then it might be confusing why you can't use it immediately, and it's great to share that expectation early

This seems more like a UX expectation thing, so I'll let @joshcoppola give his opinion

Copy link

Choose a reason for hiding this comment

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

I agree with @fubuloubu that it's better to be honest that things will take some time rather than leave a user confused that they can't instantly use the cluster.

How about something like "Provisioning a cluster usually takes 10 minutes, but could take as long as an hour"? That communicates the expected time while still giving some buffer if things do take way longer than we expect.

Then we could also follow up with something like "For safety purposes, ApePay streams are always locked for one hour" to communicate that side of things (I'm out of my element on how to phrase that but you get the idea)

Copy link
Contributor

Choose a reason for hiding this comment

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

I sure never said lie. I was just suggesting make it more in line with reality.

If you want to set expectations to be like 6x what we expect then to be then so be it. But it's not like we've seen an hour long deploy though. And the cancellation window has nothing to do with how long the deployment would take.

Copy link

Choose a reason for hiding this comment

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

I didn't mean to imply you were advocating for lying, I meant to agree with @fubuloubu 's point about sharing the time expectation with users.

I don't have an informed opinion on exactly how much buffer time would be good to communicate, mainly I wanted to point out that we could include the actual expected time and another value with some buffer time in the message.

Even though it is separate from cluster deployment, I think it's worth mentioning the ApePay cancellation window somewhere if we don't already call that out somewhere else.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think we can fuse it all together and say the expectation is 10 minutes, but it may take longer, and you can't cancel it until an hour has passed.

Check back after 10-15 minutes using the [`silverback cluster info`][silverback-cluster-info] command to see when it's ready.

At any point after the Cluster is funded, you can fund it with more funds via [`silverback cluster pay add-time`][silverback-cluster-pay-add-time]
command to extend the timeline that the Cluster is kept around for.
Note that it is possible for anyone to add more time to the Cluster, at any time and for any amount.

If that timeline expires, the Platform will automatically de-provision your infrastructure, and it is not possible to reverse this!
The Platform may send you notifications when your Stream is close to expiring, but it is up to you to remember to fill it so it doesn't.
Note that your data collection will stay available for up to 30 days allowing you the ability to download any data you need.

Lastly, if you ever feel like you no longer need your Cluster, you can cancel the funding for it and get a refund of the remaining funds.
If you are the owner of the Stream, you can do this via the [`silverback cluster pay cancel`][silverback-cluster-pay-cancel] command.
Only the owner may do this, so if you are not the owner you should contact them to have them do that action for you.

## Connecting to your Cluster

To connect to a cluster, you can use commands from the [`silverback cluster`][silverback-cluster] subcommand group.
Expand Down Expand Up @@ -178,6 +195,9 @@ TODO: Downloading metrics from your Bot
[silverback-cluster-health]: ../commands/cluster.html#silverback-cluster-health
[silverback-cluster-info]: ../commands/cluster.html#silverback-cluster-info
[silverback-cluster-new]: ../commands/cluster.html#silverback-cluster-new
[silverback-cluster-pay-add-time]: ../commands/cluster.html#silverback-cluster-pay-add-time
[silverback-cluster-pay-cancel]: ../commands/cluster.html#silverback-cluster-pay-cancel
[silverback-cluster-pay-create]: ../commands/cluster.html#silverback-cluster-pay-create
[silverback-cluster-registry-auth-new]: ../commands/cluster.html#silverback-cluster-registry-auth-new
[silverback-cluster-vars]: ../commands/cluster.html#silverback-cluster-vars
[silverback-cluster-vars-info]: ../commands/cluster.html#silverback-cluster-vars-info
Expand Down
1 change: 1 addition & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
url="https://github.com/ApeWorX/silverback",
include_package_data=True,
install_requires=[
"apepay>=0.3.1,<1",
"click", # Use same version as eth-ape
"eth-ape>=0.7,<1.0",
"ethpm-types>=0.6.10", # lower pin only, `eth-ape` governs upper pin
Expand Down
Loading
Loading