Skip to content

Stabilize transaction to version 1 #139

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 6 commits into from
Mar 13, 2024
Merged

Stabilize transaction to version 1 #139

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f00a963
transaction: Stabilize `transaction_v1_broadcast`
lexnv Feb 26, 2024
a2856b3
transaction: Stabilize `transaction_v1_stop`
lexnv Feb 26, 2024
e51c5c9
transactionWatch: Stabilize `transactionWatch_v1_submitAndWatch`
lexnv Feb 26, 2024
10e0d8e
transactionWatch: Stabilize `transactionWatch_v1_unwatch`
lexnv Feb 26, 2024
11551fb
Revert "transactionWatch: Stabilize `transactionWatch_v1_unwatch`"
lexnv Mar 6, 2024
f83133a
Revert "transactionWatch: Stabilize `transactionWatch_v1_submitAndWat…
lexnv Mar 6, 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: 2 additions & 2 deletions src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@
- [sudo_sessionKeys]()
- [sudo_sessionKeys_unstable_generate](api/sudo_sessionKeys_unstable_generate.md)
- [transaction](api/transaction.md)
- [transaction_unstable_broadcast](api/transaction_unstable_broadcast.md)
- [transaction_unstable_stop](api/transaction_unstable_stop.md)
- [transaction_v1_broadcast](api/transaction_v1_broadcast.md)
- [transaction_v1_stop](api/transaction_v1_stop.md)
- [transactionWatch](api/transactionWatch.md)
- [transactionWatch_unstable_submitAndWatch](api/transactionWatch_unstable_submitAndWatch.md)
- [transactionWatch_unstable_unwatch](api/transactionWatch_unstable_unwatch.md)
4 changes: 2 additions & 2 deletions src/api/transaction_unstable_broadcast.md → src/api/transaction_v1_broadcast.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# transaction_unstable_broadcast
# transaction_v1_broadcast

**Parameters**:

Expand All @@ -8,7 +8,7 @@

The string returned by this function is opaque and its meaning can't be interpreted by the JSON-RPC client.

Once this function has been called, the JSON-RPC server will try to propagate this transaction over the peer-to-peer network until `transaction_unstable_stop` is called.
Once this function has been called, the JSON-RPC server will try to propagate this transaction over the peer-to-peer network until `transaction_v1_stop` is called.

The JSON-RPC server must allow at least 4 transactions being broadcasted at the same time per JSON-RPC client.
Any attempt to broadcast more than 4 transactions simultaneously might result in `null` being returned.
Expand Down
6 changes: 3 additions & 3 deletions src/api/transaction_unstable_stop.md → src/api/transaction_v1_stop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# transaction_unstable_stop
# transaction_v1_stop

**Parameters**:

- `operationId`: Opaque string equal to the value returned by `transaction_unstable_broadcast`
- `operationId`: Opaque string equal to the value returned by `transaction_v1_broadcast`

**Return value**: *null*

The node will no longer try to broadcast the transaction over the peer-to-peer network.

## Possible errors

A JSON-RPC error is generated if the `operationId` doesn't correspond to any active `transaction_unstable_broadcast` operation.
A JSON-RPC error is generated if the `operationId` doesn't correspond to any active `transaction_v1_broadcast` operation.