-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
95 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
<br /> | ||
<div align="center"> | ||
<img src="https://static.sismo.io/readme/top-main.png" alt="Logo" width="150" height="150" style="borderRadius: 20px"> | ||
|
||
<h3 align="center"> | ||
Sismo Connect Solidity | ||
</h3> | ||
|
||
<p align="center"> | ||
Made by <a href="https://docs.sismo.io/" target="_blank">Sismo</a> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://twitter.com/sismo_eth" target="_blank"> | ||
<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white"/> | ||
</a> | ||
<a href="https://discord.gg/sismo" target="_blank"> | ||
<img src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white"/> | ||
</a> | ||
<a href="https://builders.sismo.io" target="_blank"> | ||
<img src="https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"/> | ||
</a> | ||
</p> | ||
</div> | ||
|
||
|
||
Sismo Connect Solidity is a Solidity library that allows you to verify the zk-proofs of your Sismo Connect Application onchain and simplify the use of the [sismo-connect-onchain-verifier](https://github.com/sismo-core/sismo-connect-onchain-verifier). | ||
|
||
Here is the link to the full documentation of the library: [Sismo Connect Solidity Library](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/solidity) | ||
|
||
You can learn more on Sismo Connect [here](hhttps://docs.sismo.io/sismo-docs/build-with-sismo-connect/getting-started). | ||
|
||
### Prerequisites | ||
|
||
- [Node.js](https://nodejs.org/en/download/) >= 18.15.0 (Latest LTS version) | ||
- [Yarn](https://classic.yarnpkg.com/en/docs/install) | ||
|
||
## Usage | ||
|
||
### Installation | ||
|
||
```bash | ||
# install the package | ||
yarn add @sismo-core/sismo-connect-solidity | ||
``` | ||
|
||
### Import the library | ||
In your solidity file: | ||
|
||
```solidity | ||
import {SismoConnect} from "@sismo-core/sismo-connect-solidity/contracts/SismoConnectLib.sol"; | ||
``` | ||
|
||
You will find here how to use the library: [Sismo Connect Solidity Library](https://docs.sismo.io/build-with-sismo-connect/technical-documentation/solidity) | ||
|
||
## License | ||
|
||
Distributed under the MIT License. | ||
|
||
## Contribute | ||
|
||
Please, feel free to open issues, PRs or simply provide feedback! | ||
|
||
## Contact | ||
|
||
Send us a message in [Telegram](https://builders.sismo.io/) or [Discord](https://discord.gg/sismo) | ||
|
||
<br/> | ||
<img src="https://static.sismo.io/readme/bottom-main.png" alt="bottom" width="100%" > |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
{ | ||
"name": "@sismo-core/sismo-connect-solidity", | ||
"description": "Sismo Connect Library", | ||
"version": "0.0.20", | ||
"scripts": { | ||
"prepare": "mkdir -p contracts; cp -r ../src/* contracts" | ||
}, | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/sismo-core/sismo-connect-onchain-verifier.git" | ||
}, | ||
"keywords": [ | ||
"solidity", | ||
"ethereum", | ||
"smart", | ||
"contracts" | ||
], | ||
"author": "Sismo <[email protected]>", | ||
"license": "MIT", | ||
"bugs": { | ||
"url": "https://github.com/sismo-core/sismo-connect-onchain-verifier/issues" | ||
}, | ||
"homepage": "https://github.com/sismo-core/sismo-connect-onchain-verifier#readme", | ||
"main": "index.js" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.