Skip to content

Commit 39d1d75

Browse files
authored
s/unmaskInput/unmaskPoint in the readme (#17)
* s/unmaskInput/unmaskPoint in the readme * s/unmaskInput/unmaskPoint in the docs
1 parent d9c39b1 commit 39d1d75

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public maskInput(input: string): IMaskedData
7777
public maskPoint(point: Uint8Array): IMaskedData
7878
```
7979

80-
**unmaskInput**: applies the multiplicative inverse of the mask to the masked point
80+
**unmaskPoint**: applies the multiplicative inverse of the mask to the masked point
8181
```Typescript
8282
public unmaskPoint(maskedPoint: Uint8Array, mask: Uint8Array): Uint8Array
8383
```
@@ -142,7 +142,7 @@ send(oprf.encodePoint(salted, 'UTF-8'));
142142
// Make sure that masked.mask corresponds to the original mask used.
143143
// Otherwise, this will not give you the correct output.
144144
const salted = oprf.decodePoint(receive(), 'UTF-8');
145-
const unmasked = oprf.unmaskInput(salted, masked.mask);
145+
const unmasked = oprf.unmaskPoint(salted, masked.mask);
146146
```
147147

148148

docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h2>Public Functions</h2>
121121
<pre><code class="language-Typescript"><span class="hljs-keyword">public</span> maskInput(input: <span class="hljs-built_in">string</span>): IMaskedData</code></pre>
122122
<p><strong>maskPoint</strong>: applies a random mask to an elliptic curve point</p>
123123
<pre><code class="language-Typescript"><span class="hljs-keyword">public</span> maskPoint(point: <span class="hljs-built_in">Uint8Array</span>): IMaskedData</code></pre>
124-
<p><strong>unmaskInput</strong>: applies the multiplicative inverse of the mask to the masked point</p>
124+
<p><strong>unmaskPoint</strong>: applies the multiplicative inverse of the mask to the masked point</p>
125125
<pre><code class="language-Typescript"><span class="hljs-keyword">public</span> unmaskPoint(maskedPoint: <span class="hljs-built_in">Uint8Array</span>, mask: <span class="hljs-built_in">Uint8Array</span>): <span class="hljs-built_in">Uint8Array</span></code></pre>
126126
<p><strong>generateRandomScalar</strong>: generates a uniform random 32-byte number in [1, order of curve)</p>
127127
<pre><code class="language-Typescript"><span class="hljs-keyword">public</span> generateRandomScalar(): <span class="hljs-built_in">Uint8Array</span></code></pre>
@@ -160,7 +160,7 @@ <h2>OPRF Steps</h2>
160160
<pre><code class="language-Typescript"><span class="hljs-comment">// Make sure that masked.mask corresponds to the original mask used.</span>
161161
<span class="hljs-comment">// Otherwise, this will not give you the correct output.</span>
162162
<span class="hljs-keyword">const</span> salted = oprf.decodePoint(receive(), <span class="hljs-string">&#x27;UTF-8&#x27;</span>);
163-
<span class="hljs-keyword">const</span> unmasked = oprf.unmaskInput(salted, masked.mask);</code></pre>
163+
<span class="hljs-keyword">const</span> unmasked = oprf.unmaskPoint(salted, masked.mask);</code></pre>
164164
<hr>
165165
<p>Implementation inspired by Burns et. al.
166166
<a href="https://pdfs.semanticscholar.org/5d33/ea1d3fda454875a6a6ee7c535c80c74af512.pdf">https://pdfs.semanticscholar.org/5d33/ea1d3fda454875a6a6ee7c535c80c74af512.pdf</a></p>
@@ -206,4 +206,4 @@ <h2>Legend</h2>
206206
<div class="overlay"></div>
207207
<script src="assets/js/main.js"></script>
208208
</body>
209-
</html>
209+
</html>

0 commit comments

Comments
 (0)