Skip to content

Commit 3cb112c

Browse files
authored
Update README.md
1 parent 84c8eb9 commit 3cb112c

File tree

1 file changed

+10
-25
lines changed

1 file changed

+10
-25
lines changed

Diff for: README.md

+10-25
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ Inputs:
8686
EPOCH_LIMIT_SECRET: Browser's private epoch-limit key
8787
Intermediate:
8888
EPOCH_LIMIT_PUBLIC: Public epoch-limit key generated from EPOCH_LIMIT_SECRET
89-
EPOCH_LIMIT_PROOF: A bytestring representing a zero-knowledge proof of
90-
knowledge of EPOCH_LIMIT_SECRET.
89+
EPOCH_LIMIT_PROOF: A bytestring representing a zero-knowledge proof of knowledge of EPOCH_LIMIT_SECRET.
9190
Output:
9291
REQUEST: Bytestring containing EPOCH_LIMIT_PUBLIC and EPOCH_LIMIT_PROOF
9392
```
@@ -117,8 +116,7 @@ Inputs:
117116
SITE_PUBLIC: Public key generated from SITE_SECRET
118117
TOKEN: Bytestring containing VALUE and SIG
119118
Output:
120-
VALID: Boolean indicating whether TOKEN was issued using EPOCH_LIMIT_SECRET
121-
and SITE_PUBLIC.
119+
VALID: Boolean indicating whether TOKEN was issued using EPOCH_LIMIT_SECRET and SITE_PUBLIC.
122120
```
123121

124122
#### Proof Generation Algorithm
@@ -131,21 +129,14 @@ Inputs:
131129
SITE_PUBLIC: Public key generated from SITE_SECRET
132130
TOKEN: Bytestring containing VALUE and SIG
133131
BOUND: Integer which we want to prove VALUE is less than or equal to
134-
EPOCH_LENGTH: Integer in seconds representing the length of a given epoch
135-
for rate limiting purposes.
136-
EPOCH_LIMIT: Integer between 0 and 2^17 exclusive representing the maximum
137-
tokens possible to issue in a given epoch.
132+
EPOCH_LENGTH: Integer in seconds representing the length of a given epoch for rate limiting purposes.
133+
EPOCH_LIMIT: Integer between 0 and 2^17 exclusive representing the maximum tokens possible to issue in a given epoch.
138134
COUNTER: Amount of proofs issued in current epoch (excluding this one).
139135
PROOF_ID: String used to trace this specific proof generation request.
140136
Intermediates:
141137
EPOCH: The current epoch according to EPOCH_LENGTH and the current time.
142-
EPOCH_LIMIT_RANDOM: Output of a VRF seeded by EPOCH_LIMIT_SECRET and applied
143-
to EPOCH and COUNTER.
144-
T_PROOF: Non-Interactive Zero-Knowledge Proof that TOKEN was issued using
145-
EPOCH_LIMIT_SECRET and SITE_PUBLIC, that VALUE <= BOUND, that
146-
EPOCH_LIMIT_RANDOM was properly calculated, that COUNTER <
147-
EPOCH_LIMIT, that the current time is within EPOCH, and of
148-
PROOF_ID's value.
138+
EPOCH_LIMIT_RANDOM: Output of a VRF seeded by EPOCH_LIMIT_SECRET and applied to EPOCH and COUNTER.
139+
T_PROOF: Non-Interactive Zero-Knowledge Proof that TOKEN was issued using EPOCH_LIMIT_SECRET and SITE_PUBLIC, that VALUE <= BOUND, that EPOCH_LIMIT_RANDOM was properly calculated, that COUNTER < EPOCH_LIMIT, that the current time is within EPOCH, and of PROOF_ID's value.
149140
Output:
150141
PROOF: Bytestring containing EPOCH_LIMIT_RANDOM and T_PROOF.
151142
```
@@ -159,16 +150,11 @@ Inputs:
159150
SITE_SECRET: Server's private key
160151
PROOF: Bytestring containing EPOCH_LIMIT_RANDOM and T_PROOF.
161152
BOUND': Integer which we want to prove VALUE is less than or equal to
162-
EPOCH_LENGTH: Integer in seconds representing the length of a given epoch
163-
for rate limiting purposes.
164-
EPOCH_LIMIT: Integer between 0 and 2^17 exclusive representing the maximum
165-
tokens possible to issue in a given epoch.
153+
EPOCH_LENGTH: Integer in seconds representing the length of a given epoch for rate limiting purposes.
154+
EPOCH_LIMIT: Integer between 0 and 2^17 exclusive representing the maximum tokens possible to issue in a given epoch.
166155
PROOF_ID: String used in generating PROOF to demonstrate provenance.
167156
Intermediates:
168-
EPOCH: The current epoch according to EPOCH_LENGTH and the current time. The
169-
server may decide to try multiple EPOCHs (for example, the ones
170-
immediately before or after) to prevent issues around EPOCH
171-
boundaries.
157+
EPOCH: The current epoch according to EPOCH_LENGTH and the current time. The server may decide to try multiple EPOCHs (for example, the ones immediately before or after) to prevent issues around EPOCH boundaries.
172158
Output:
173159
VALID: Boolean indicating whether or not PROOF is valid.
174160
```
@@ -281,8 +267,7 @@ partial interface PrivateProofManager {
281267
// same site as this context, if `url` was not HTTPS, if the request
282268
// failed, if decoding the response fails, or if rate limiting was
283269
// exceeded for this function.
284-
Promise<any> sendProofForLessThanOrEqual(
285-
number bound, USVString id, USVString url);
270+
Promise<any> sendProofForLessThanOrEqual(number bound, USVString id, USVString url);
286271
}
287272
```
288273

0 commit comments

Comments
 (0)