Skip to content

Commit 9b57feb

Browse files
authored
docs: update README.md (#264)
* docs: update README.md * format: prettier
1 parent 55a2323 commit 9b57feb

File tree

1 file changed

+10
-94
lines changed

1 file changed

+10
-94
lines changed

README.md

Lines changed: 10 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,19 @@
1-
# Golden Smart Contracts
1+
# Golden.xyz
22

3-
- Managed with [Hardhat](https://hardhat.org/getting-started/) and [Hardhat Deploy](https://github.com/wighawag/hardhat-deploy)
3+
Contracts to support Golden's decentralized protocol for knowledge. These contracts are in the R&D phase. [Learn More.](https://docs.golden.xyz/)
44

5-
## Development
6-
7-
First install dependencies
8-
9-
```
10-
yarn
11-
```
12-
13-
To reset your types and hardhat cache
14-
15-
```
16-
yarn compile
17-
```
18-
19-
For local development you shouldn't need anything else.
20-
21-
## Test
5+
# Contributions
226

23-
Run tests with
24-
25-
```
26-
yarn test
27-
```
7+
Contributions are welcomed and encouraged! You can contribute by:
288

29-
In order to deploy to a testnet you'll need to setup some env variables.
30-
Copy `.env.example` to `.env` and supply necessary variables as follows:
31-
32-
#### `ETHERSCAN_API_KEY`
33-
34-
You'll need to signup for an account here: https://etherscan.io/register and then get your api key here: https://etherscan.io/myapikey
35-
36-
#### `[SEPOLIA|GOERLI|POLYGON|MUMBAI|ETC]_URL`
37-
38-
This is a 3rd party node provider RPC url. You can set up an account at https://Alchemy.io.
39-
40-
#### `PRIVATE_KEY`
41-
42-
This is the private key to an account you want to use for deploy.
43-
44-
#### `REPORT_GAS`
45-
46-
This boolean determines whether to calculate gas costs for deployment of contracts.
47-
48-
##### `Deploy Sepolia: `
49-
50-
Latest deployed contracts details are stored in `deployments/` for each network that has been deployed to. The main file of interest is the `*.json` of a contract which has it's address.
51-
To deploy to Sepolia testnet run:
52-
53-
```
54-
npx hardhat deploy --network sepolia
55-
```
9+
- Creating an issue
10+
- Opening a PR. If you are opening a PR, it is a good idea to first join our [Discord](https://discord.com/invite/golden-protocol) and discuss your idea!
5611

57-
To get the deployed contract verified with etherscan run
58-
59-
```
60-
npx hardhat verify <contract_address> --network sepolia
61-
```
62-
63-
To get the deployed contract with constructor arguments verified with etherscan run
64-
65-
```
66-
npx hardhat verify --constructor-args arguments.js <contract_address> --network sepolia
67-
```
68-
69-
where arguments.js is just a file returning an array of arguments `module.exports = ["0xabcdef", 51];`
70-
71-
##### `Deploy Arbitrum Goerli: `
72-
73-
_Only for NFT contracts_
74-
Same commands but with network: arbitrumGoerli
75-
76-
## GoldenToken
12+
## Development
7713

78-
Guide to get verified for thumbnail and other metadata [here](https://info.etherscan.com/token-update-guide/)
14+
1. `yarn install`
15+
2. `yarn compile`
16+
3. Run tests `yarn test`
7917

8018
## Upgrades
8119

@@ -86,28 +24,6 @@ Upgrades are dealt with automatically, just make a change in the contract and de
8624

8725
Once the contract is deployed you can interact with it. <br />These commands will use the address set in the `hardhat.config.ts` as the signer. <br />By default it's the same address that deployed the contract (owner).
8826

89-
## Staking
90-
91-
_These tasks will only work if your deployer owns the contract_
92-
93-
#### `sendToken`
94-
95-
```
96-
npx hardhat sendToken --network hardhat --to 0xB9563F6aEd9a3986Fe0e4B57cA1Af40dBD7F7720 --amount 10
97-
```
98-
99-
#### `slash`
100-
101-
```
102-
npx hardhat slash --network hardhat --account 0xB9563F6aEd9a3986Fe0e4B57cA1Af40dBD7F7720 --amount 10
103-
```
104-
105-
#### `stake`
106-
107-
```
108-
npx hardhat stake --network hardhat --amount 10
109-
```
110-
11127
### Schema governance proposals
11228

11329
#### `addPredicate`

0 commit comments

Comments
 (0)