mirror of
https://github.com/tlsnotary/tlsn-js.git
synced 2026-01-08 20:18:01 -05:00
4f9c6f3ee6ea38628df11a53bf356d498b42c158
* wip: testing error catching * chore: version update * chore: add mocha test boilerplate * chore: fix linter
tlsn-js
NPM Modules for proving and verifying using TLS Notary in the browser.
The prover requires a notary-server and websockify proxy
Example
import { prove, verify } from '../src';
// To create a proof
const proof = await prove('https://swapi.dev/api/people/1', {
method: 'GET',
headers: {
Connection: 'close',
Accept: 'application/json',
'Accept-Encoding': 'identity',
},
body: '',
maxTranscriptSize: 20000,
notaryUrl: 'https://127.0.0.1:7047',
websocketProxyUrl: 'ws://127.0.0.1:55688',
});
// To verify a proof
const result = await verify(proof);
console.log(result);
Running a local websockify proxy for https://swapi.dev
git clone https://github.com/novnc/websockify && cd websockify
./docker/build.sh
docker run -it --rm -p 55688:80 novnc/websockify 80 swapi.dev:443
Install as NPM Package
npm install tlsn-js
Development
# make sure you have rust install
# https://www.rust-lang.org/tools/install
npm install
# this serve a page that will execute the example code at http://localhost:3001
npm run dev
Build for NPM
npm install
npm run build
Description
Releases
10
Languages
TypeScript
87.2%
JavaScript
9.8%
Shell
1.6%
EJS
1.4%