hueso/p2pix-smart-contracts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve README.md with Installation and test scripts.

Browse Source
This commit is contained in:
Filipe Soccol 2022-10-25 10:23:49 -03:00
parent 208a3afcd2
commit 960468e23e
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,2 +1,34 @@
# p2pix-smart-contracts # p2pix-smart-contracts
Repository for P2Pix EVM contracts to be imported by the project. Repository for P2Pix EVM contracts to be imported by the project.
## Installation
Import the repository on your app to allow use the artifacts for Ethers.
```
npm install --save git+https://github.com/doiim/p2pix-smart-contracts.git
```
To import artifacts on the project use the following:
```
import P2PIXArtifact from 'p2pix-smart-contracts/artifacts/contracts/p2pix.sol/P2PIX.json'
```
Then use a Contract instance to interact directly with it:
```
const p2pixContract = new ethers.Contract(address, P2PIXArtifact.abi, signer);
```
## Testing
To run tests, clone this repo, install dependencies and run Hardhat tests.
```
git clone https://github.com/doiim/p2pix-smart-contracts.git
cd p2pix-smart-contract
npm install
npx hardhat test
```