https://github.com/masaun/zktls-integration-examples
zkTLS integration examples using Noir-Web-Prover circuit
https://github.com/masaun/zktls-integration-examples
hardhat noir noir-web-prover zero-knowledge-proof zktls
Last synced: 5 months ago
JSON representation
zkTLS integration examples using Noir-Web-Prover circuit
- Host: GitHub
- URL: https://github.com/masaun/zktls-integration-examples
- Owner: masaun
- Created: 2025-07-06T12:11:05.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-09-29T07:51:19.000Z (5 months ago)
- Last Synced: 2025-09-29T09:27:52.771Z (5 months ago)
- Topics: hardhat, noir, noir-web-prover, zero-knowledge-proof, zktls
- Language: Solidity
- Homepage:
- Size: 708 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 【IN PROGRESS】zkTLS Integration Examples
## Overview
- This repo is the `zkTLS` integration examples using the `Noir Web Prover` circuit:
https://github.com/pluto/noir-web-prover-circuits
- I'm going to experiment to create `zkTLS` proofs for various Web2 APIs in this repo.
## ZK circuit test
- Run the test of the `Sample` zkTLS circuit
```bash
cd noir/zktls-integrations
sh circuit_test.sh
```
- Run the test of the `OKX DEX API` zkTLS circuit
```bash
cd noir/zktls-integration-with-okx-dex-api
sh circuit_test.sh
```
- Run the test of the `DocuSign` zkTLS circuit
```bash
cd noir/zktls-docusign
sh circuit_test.sh
```
## Run (in `TS`) with `OKX DEX SDK`
- Create an `.env` by copying the `.env.example`
```bash
cd scripts/OKX-DEX-API
cp .env.example .env
```
- GET a API request header
```bash
cd scripts/OKX-DEX-API
sh okx-dex-sdk-integrations/runningScript_okx-dex-sdk-api-request-sample.sh
```
## Run the test of the Smart Contracts
- Run the test of the Smart Contracts for the `zktls-integrations` circuit (`./test/circuits/zktls-integrations/ZkTLSIntegrationsProofVerifier.test.ts`)
```bash
cd test
sh circuits/zktls-integrations/runningTest_ZkTLSIntegrationsProofVerifier.sh
```
- Run the test of the Smart Contracts for the `zktls-integration-with-okx-dex-api` circuit (`./test/circuits/zktls-integration-with-okx-dex-api/ZkTLSIntegrationsProofVerifier.test.ts`)
```bash
cd test
sh circuits/zktls-integration-with-okx-dex-api/runningTest_ZkTLSIntegrationsProofVerifier.sh
```
# Hardhat Noir Starter
This project demonstrates Noir integration with Hardhat using [Hardhat Noir](https://github.com/olehmisar/hardhat-noir) plugin.
## Getting started
Clone this repository and run `npm install`:
```sh
npx degit olehmisar/hardhat-noir-starter my-first-noir-project
cd my-first-noir-project
npm install
```
Then, run `npm run test` to run the tests.
## Development
1. Write circuits in `noir` folder.
2. `npx hardhat noir-new ` to create a new Noir circuit.
3. `npm run compile` to compile Noir and Solidity.
4. Integrate with [Solidity verifiers](https://noir-lang.org/docs/how_to/how-to-solidity-verifier) auto-generated by Noir.
## Testing
1. Write tests in `test` folder.
2. `npm run test` to run the tests.
## Deployment
Noir integrates with Solidity, so you can deploy your Solidity contracts like in any other Solidity project using the official [Hardhat Ignition](https://hardhat.org/ignition/docs/getting-started) or community maintained [Hardhat Deploy](https://github.com/wighawag/hardhat-deploy).