You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-94Lines changed: 10 additions & 94 deletions
Original file line number
Diff line number
Diff line change
@@ -1,81 +1,19 @@
1
-
# Golden Smart Contracts
1
+
# Golden.xyz
2
2
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/)
4
4
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
22
6
23
-
Run tests with
24
-
25
-
```
26
-
yarn test
27
-
```
7
+
Contributions are welcomed and encouraged! You can contribute by:
28
8
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!
56
11
57
-
To get the deployed contract verified with etherscan run
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
77
13
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`
79
17
80
18
## Upgrades
81
19
@@ -86,28 +24,6 @@ Upgrades are dealt with automatically, just make a change in the contract and de
86
24
87
25
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).
88
26
89
-
## Staking
90
-
91
-
_These tasks will only work if your deployer owns the contract_
0 commit comments