# Sample Hardhat Project

This project demonstrates a basic Shield use case. It comes with a sample contract and circuit, a test for the contract and circuit integration, and a script that deploys that contract.

Try running some of the following tasks:

## Compile & Build

To Build circuits and compile contracts, use the build task:

```shell

npm run build
```

To compile contracts, use the task:

```shell

npm run compile
```

To compile and build circuits, use the task:

```shell

shield compile
```

## Debug & Generate Witness

```
shield debug
```

## Clean

clean the compiled artifacts saved in the artifacts/:

```shell

npm run clean
```

clean the compiled circuit build files saved in the circuits/build:

```shell

npm run clean:circuits
```

## Running Tests

To run tests, run the following command

```shell

npm run test
```

## Deployment

To deploy this project on localhost run :

```bash

  npm run node
  npm run deploy:localhost

```