Skip to content

Commit

Permalink
Finalize ticket proof configuration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
robknight committed Oct 4, 2024
1 parent 69f8b10 commit 097d89b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions apps/docs/src/content/docs/guides/ticket-proofs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ As we saw in the original proof request, the `attendeeEmail` entry is revealed:

To understand how this works, read on!

# What's in a ticket proof
# Configuring a ticket proof request

Ticket proofs enable the user to prove that they hold an event ticket matching certain criteria. They also allow the user to selectively reveal certain pieces of data contained in the ticket, such as their email address or name.

Expand Down Expand Up @@ -224,6 +224,12 @@ const request = ticketProofRequest({
});
```

## Watermark

You can add a watermark to your proof, which allows you to uniquely identify a proof. Precisely which value to use for the watermark depends on your application and use-case, but you might use a unique session ID, or a single-use number generated by your application.

## Watermark
If you add a watermark to your proof request, you can check the watermark when later verifying the proof. A typical workflow might involve your client application requesting a random number from your server, which stores the number. The number is passed as a watermark in the proof request, and then you can send the proof to the server for verification. The server then checks that the watermark is equal to the random number it generated. By requiring the watermark to equal some single-use secret value, you ensure that the client cannot re-use a previously-generated proof.

# Verifying a ticket proof

TODO.

0 comments on commit 097d89b

Please sign in to comment.