Skip to content

docs: bump docs on payment service and SDK - #1168

Merged
entropidelic merged 5 commits into
stagingfrom
1112-add-docs-on-how-the-payment-system-works
Oct 14, 2024
Merged

docs: bump docs on payment service and SDK#1168
entropidelic merged 5 commits into
stagingfrom
1112-add-docs-on-how-the-payment-system-works

Conversation

@uri-99

Copy link
Copy Markdown
Contributor

No description provided.

@uri-99uri-99 self-assigned this Oct 3, 2024
@uri-99uri-99 linked an issue Oct 3, 2024 that may be closed by this pull request
@uri-99
uri-99 changed the base branch from testnet to stagingOctober 3, 2024 17:12
## 2. Send funds to Aligned

To be able to send proofs to Aligned using the Batcher, the user must fund its transactions. For this, there is a simple Batcher Payment System.
To send proofs to Aligned using the Batcher, the user must first deposit some funds in Aligned to pay for the verification of his proofs.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I recommend we are explicit try to be specific about what part of Aligned we are interacting with something like the user must first deposit some funds in Aligned to pay -> the user must first deposit funds into the Aligned BatcherPaymentService to pay for the verification. The Batcher verifies the user has available to pay for its proof before processing its proof contract payment contract.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

The idea of this PR was actually to remove this because the user doesn't need this information here. This information is better explained in docs/2_architecture/components/2_payment_service_contract.md

@JuArceJuArce left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The PR title does not make sense with the PR changes. Maybe I'm wrong

@uri-99uri-99 changed the title docs: better document batcher payments servicedocs: better docs on payment service and SDKOct 8, 2024
@uri-99uri-99 changed the title docs: better docs on payment service and SDKdocs: bump docs on payment service and SDKOct 8, 2024
@uri-99

Copy link
Copy Markdown
ContributorAuthor

The PR title does not make sense with the PR changes. Maybe I'm wrong

I have changed the PR title to a more appropriate one

@JuArce

JuArce commented Oct 8, 2024

Copy link
Copy Markdown
Collaborator

I have changed the PR title to a more appropriate one

Does it solve the original issue?

@uri-99

Copy link
Copy Markdown
ContributorAuthor

I have changed the PR title to a more appropriate one

Does it solve the original issue?

yes

@entropidelic
entropidelic merged commit ae8d8f3 into stagingOct 14, 2024
@entropidelic
entropidelic deleted the 1112-add-docs-on-how-the-payment-system-works branch October 14, 2024 18:57
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add docs on how the payment system works

4 participants

@uri-99@JuArce@PatStiles@entropidelic