Skip to content

Commit

Permalink
feat: hardhat configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
yum0e committed Jul 27, 2023
1 parent 89edd94 commit f3a4455
Show file tree
Hide file tree
Showing 4 changed files with 95 additions and 17 deletions.
69 changes: 69 additions & 0 deletions .hardhat/README.md
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%" >
25 changes: 25 additions & 0 deletions .hardhat/package.json
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"
}
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
"prettier-plugin-solidity": "^1.0.0-beta.13"
},
"scripts": {
"lint": "prettier --write **.sol",
"setup-fork": "./script/bash/setup-fork.sh"
"lint": "prettier --write **.sol"
}
}
15 changes: 0 additions & 15 deletions src/interfaces/IBaseVerifier.sol

This file was deleted.

0 comments on commit f3a4455

Please sign in to comment.