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

Make documentation consistent re: Tezos API waiting behavior #335

Open
marsella opened this issue Nov 24, 2021 · 0 comments
Open

Make documentation consistent re: Tezos API waiting behavior #335

marsella opened this issue Nov 24, 2021 · 0 comments

Comments

@marsella
Copy link
Contributor

I think there is some discrepancy between the behavior of the code, the documentation of the code, and the documentation of the spec re: verification of contract status/updates on Tezos. (e.g. verify that the contract was originated correctly, verify that the contract was funded correctly).

The actual behavior of the code is that it looks at the current state of the contract and fails if the status is not what is expected.

I think some of the documentation refers to an outdated plan in which the API would check the state of the contract at intervals until either the status is met or a timeout elapses. This was meant to be an approximation of the notification service (in which the verifying party would receive a notification when the updated occurs) and was abandoned because of deadline pressure (the current implementation was much easier).

See also: #250 could be mitigated by adding waiting behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant