Skip to content

docs: improves code example legibility #3

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
AaronPerezPerez wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improves code example legibility #3

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
15 changes: 8 additions & 7 deletions packages/sphincs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,34 @@ it is recommended to use

## Example Usage

```typescript
import {sphincs} from 'sphincs';

const keyPair /*: {privateKey: Uint8Array; publicKey: Uint8Array} */ =
const keyPair: {privateKey: Uint8Array; publicKey: Uint8Array} =
await sphincs.keyPair()
;

const message /*: Uint8Array */ =
const message: Uint8Array =
new Uint8Array([104, 101, 108, 108, 111, 0]) // "hello"
;

/* Combined signatures */

const signed /*: Uint8Array */ =
const signed: Uint8Array =
await sphincs.sign(message, keyPair.privateKey)
;

const verified /*: Uint8Array */ =
const verified: Uint8Array =
await sphincs.open(signed, keyPair.publicKey) // same as message
;

/* Detached signatures */

const signature /*: Uint8Array */ =
const signature: Uint8Array =
await sphincs.signDetached(message, keyPair.privateKey)
;

const isValid /*: boolean */ =
const isValid: boolean =
await sphincs.verifyDetached(signature, message, keyPair.publicKey) // true
;

Expand All @@ -50,7 +51,7 @@ it is recommended to use
console.log(verified);
console.log(signature);
console.log(isValid);

```
## Changelog

Breaking changes in major versions:
Expand Down