Skip to content

Commit ccf84c4

Browse files
committed
add additonal info to readmes, fix tag
1 parent e2b35b2 commit ccf84c4

File tree

2 files changed

+34
-12
lines changed

2 files changed

+34
-12
lines changed

README.md

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# sw3 contracts
1+
# SW3 contracts
22

33
Contracts for Swap, Swear and Swindle.
44

@@ -121,27 +121,49 @@ For signing purposes the chequebook uses EIP-712 Ethereum typed structured data
121121

122122
`Swear` and `Swindle` are the contracts for the trial system of sw3. You can find them in the `experimental` branch.
123123

124-
## Releasing
125-
126-
To release a new stable version, tag the commit without the `-rcX` suffix.
127-
For example, to release `v0.4.0`, execute the following command: `git tag v0.4.0 && git push origin v0.4.0`.
128-
This will generate Golang source code for the smart contracts and publish it to the [`ethersphere/go-sw3-abi/`](https://github.com/ethersphere/go-sw3-abi/) repository.
129124

125+
# Price-Oracle contracts
130126

131-
# Price-Oracle
132-
133-
This repo also contains the contracts and tests for the swarm price orace.
127+
This repo also contains the contracts and tests for the swarm S3 price oracle.
134128

135129
## Deployments
136130

137131
| Network | Address |
138132
| ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
139133
| XDai | [0x0FDc5429C50e2a39066D8A94F3e2D2476fcc3b85](https://gnosisscan.io/address/0x0FDc5429C50e2a39066D8A94F3e2D2476fcc3b85#code) |
140134
| Sepolia | [0xe821533d30A4250e50812Aa060EEb2E8Ef3D98f6](https://sepolia.etherscan.io/address/0xe821533d30A4250e50812Aa060EEb2E8Ef3D98f6#code) |
141-
| Goerli | [0x0c9dE531dCB38B758fe8A2c163444a5e54ee0db2](https://goerli.etherscan.io/address/0x0c9dE531dCB38B758fe8A2c163444a5e54ee0db2) |
135+
142136

143137
## Go-bindings
144138

145139
The go bindings are automatically generated on every release git tag and the pushed to the [ethersphere/go-price-oracle-abi](https://github.com/ethersphere/go-price-oracle-abi) repository.
146140

147-
To release a new stable version do the following. For example, to release v0.2.0, execute the following command: git tag v0.4.0 && git push origin v0.2.0.
141+
142+
## Releasing for S3 and Oracle
143+
144+
To release a new stable version, tag the commit without the `-rcX` suffix.
145+
For example, to release `v0.4.0`, execute the following command: `git tag v0.4.0 && git push origin v0.4.0`.
146+
This will generate Golang source code for the smart contracts and publish it to the [`ethersphere/go-sw3-abi/`](https://github.com/ethersphere/go-sw3-abi/) repository and/or https://github.com/ethersphere/go-price-oracle-abi
147+
148+
149+
### Deployments for S3 and Oracle
150+
151+
#### Method
152+
153+
All deployments and Tests are fully dependant on Hardhat Deploy library https://github.com/wighawag/hardhat-deploy and follow best practices used there
154+
155+
##### Prerequisites
156+
157+
Feel free to use public RPCs but if you want extra security and speed, feel free to use Infura, Alchemy or any other private RPC and add full path with your KEY to .env file
158+
159+
##### Steps
160+
161+
1. Run `yarn hardhat compile` to get all the contracts compiled.
162+
2. Run `yarn hardhat test` to run all the tests.
163+
3. Configure `.env` file
164+
- Set your `WALLET_SECRET` in the `.env` file.
165+
- Set your `INFURA_TOKEN` in the `.env` file.
166+
4. To deploy all contracts and set roles:
167+
- Mainnet: `yarn hardhat deploy --network mainnet`
168+
- Testnet: `yarn hardhat deploy --network testnet`
169+

deploy/test/001_deploy_oracle.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ const func: DeployFunction = async function ({ deployments, getNamedAccounts, ne
2424
}
2525
};
2626

27-
func.tags = ['factory'];
27+
func.tags = ['oracle'];
2828
export default func;

0 commit comments

Comments
 (0)