Skip to content

Add optional trace_id parameter #96

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

Open
callmedenchick wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add optional trace_id parameter #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 bridge.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,16 @@ Sending message from client A to client B. Bridge returns error if ttl is too hi

```tsx
request
POST /message?client_id=<to_hex_str(A)>?to=<to_hex_str(B)>&ttl=300&topic=<sendTransaction|signData>
POST /message?client_id=<to_hex_str(A)>?to=<to_hex_str(B)>&ttl=300[&topic=<sendTransaction|signData>][&trace_id=<uuid>]

body: <base64_encoded_message>
```


The `topic` [optional] query parameter can be used by the bridge to deliver the push notification to the wallet. If the parameter is given, it must correspond to the RPC method called inside the encrypted `message`.

trace_id [optional] — a UUID used to trace the message path; if not provided, the bridge generates a UUIDv7. The trace_id is forwarded to the recipient and included in the BridgeMessage (as "trace_id").

Bridge buffers messages up to TTL (in secs), but removes them as soon as the recipient receives the message.

If the TTL exceeds the hard limit of the bridge server, it should respond with HTTP 400. Bridges should support at least 300 seconds TTL.
Expand Down