Skip to content

Commit ce6911c

Browse files
committed
Update README.md for improved clarity and formatting
1 parent 3407f55 commit ce6911c

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

packages/smart-contract/README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
1-
#Contract Name: DataProtector
1+
# Contract Name: DataProtector
22

3-
####Description:
4-
This contract is use to attach schema on the dataset and publish it as an event.
3+
## Description
54

6-
#####Contract deployed Address:
5+
The `DataProtector` contract is designed to attach schemas to datasets and publish them as events.
76

8-
```bash
9-
0x3a4Ab33F3D605e75b6D00A32A0Fa55C3628F6A59
7+
## Deploying the Contract
8+
9+
To deploy the contract, run the following command:
10+
11+
```sh
12+
npm run deploy -- --network avalancheFuji
1013
```
14+
15+
If no network is specified, the local Hardhat network will be used by default.
16+
17+
**Note:** This deployment uses the `createX` factory through Hardhat Ignition. To modify the deployment address, update the `salt` value in the `hardhat.config.json` file.
18+
19+
## Deployed Contract Address
20+
21+
Refer to the `../../environments/environments.json` file to find the deployed contract address for the respective environment.

0 commit comments

Comments
 (0)