Skip to content

Commit 3fbc985

Browse files
committed
chore: polish README
1 parent 49e3476 commit 3fbc985

2 files changed

Lines changed: 40 additions & 35 deletions

File tree

README.md

Lines changed: 39 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Wrapped/WIT contracts and CLI tools
22

3-
> A command-line tool and smart contract suite to wrap and unwrap $WIT coins between the Witnet blockchain and Ethereum, using specific RPC endpoints for each ecosystem.
3+
> A command-line tool and smart contract suite to wrap and unwrap $WIT coins between Witnet and Ethereum blockchains, using specific RPC endpoints for each.
44
55
## ✨ Overview
66

@@ -11,11 +11,11 @@ This repository contains:
1111
- Check out both wrapped and under-custody $WIT suppies on Ethereum and Witnet.
1212
- Notarize **Proof-of-Reserve** reports on Witnet and then push them on-chain into Ethereum.
1313
- Get list of supported EVM testnets and mainnets.
14-
- Get relevant info about the ERC-20 contract on each supported EVM networks.
14+
- Get relevant info about the ERC-20 contract on each supported network.
1515
- Get history of transfer, wrap and unwrap transactions.
1616
- Measure actual time taken by cross-chain transactions.
1717

18-
- **Javascript library** allowing scripts to fetch supported networks, addresses, settings and some other helper methods.
18+
- A **Javascript library** allowing scripts to introspect supported networks, ABIs, addresses and settings, as well as some related helper methods.
1919

2020
- The full **Solidity source code** of both the canonical and bridged versions of the Wrapped/WIT ERC-20 token deployed on Ethereum and other Superchain-compliant networks.
2121

@@ -63,80 +63,85 @@ You can optionally:
6363

6464
### Commands
6565

66-
You need to have a local ETH/RPC proxy running in order to get access to extra commands. You will only be able to wrap and unwrap $WIT coins if you connect to an EVM network where the canonical version of the ERC-20 token is available (see supported networks below).
66+
You need to have a local **ETH/RPC proxy** running in order to get access to extra commands. You will only be able to wrap and unwrap $WIT coins if you connect to an EVM network where the canonical version of the ERC-20 token is available (see supported networks below).
6767

68+
---
6869
#### `$ witwrap networks`
6970
Lists supported EVM networks.
7071

71-
Flags:
72+
**Flags**:
7273
- `--mainnets`: Just list the mainnets.
7374
- `--testnets`: Just list the testnets.
7475

76+
---
7577
#### `$ witwrap proxy <evm_network>`
7678
Launches a local ETH/RPC signing proxy to the specified `evm_network`, listening on port 8545 if no otherwise specified.
7779

78-
Options:
79-
- `--port`: Port where the new proxy will be listening on.
80+
**Options**:
81+
- `--port`: Port where the new proxy should be listening on.
8082
- `--remote`: URL of the ETH/RPC remote provider to use instead of the proxy's default for the specified network.
8183

82-
Launch a proxy to your preferred EVM network on a different terminal so you can augment the available commands of the `witwrap` CLI binary.
83-
84-
> *If you launch the proxy on a port other than default's, you'll need to specify `--port <PORT>` when invoking other commands of the `witwrap` binary.*
84+
> *Launch a proxy to your preferred EVM network on a different terminal so you can augment the available commands of the `witwrap` CLI binary. If you launch the proxy on a port other than default's, you'll need to specify `--port <PORT>` when invoking other commands of the `witwrap` binary.*
8585
86+
---
8687
#### `$ witwrap contract`
8788
Shows the address and other relevant data of the WrappedWIT contract that's available on the connected EVM network.
8889

89-
Flags:
90+
**Flags**:
9091
- `--verbose`: Outputs extra information.
9192

93+
---
9294
#### `$ witwrap supply`
9395
Shows wrapped $WIT supply information on the connected EVM network. It also detects if the total reserve supply in Ethereum is outdated with respect the actual under-custody supply on Witnet, asking you whether you wish to permissionlessly contribute by notarizing (in Witnet) and pushing (in Ethereum) a fresh new **Proof-of-Reserve** report.
9496

95-
Flags:
97+
**Flags**:
9698
- `--verbose`: Outputs history of Proof-of-Reserve update reports.
9799

98-
Options:
100+
**Options**:
99101
- `--limit`: Limit number of history records.
100102
- `--from`: EVM signer address to use when pushing a fresh new Proof-of-Reserve report into Ethereum.
101103
- `--gasPrice`: Max. EVM gas price to pay when pushing a Proof-of-Reserve report into Ethereum.
102104

105+
---
103106
#### `$ witwrap transfers`
104-
Shows the history of recent transfers of wrapped $WIT on the connected EVM network. It also allows you to transfer your own wrapped $WIT tokens in Ethereum, as long the signing addresses of your EVM proxy holds some wrapped $WIT balance.
107+
Shows the history of recent transfers of wrapped $WIT on the connected EVM network. It also allows you to transfer wrapped $WIT tokens in Ethereum, as long the signing addresses of your EVM proxy holds some wrapped $WIT balance.
105108

106-
Flags:
109+
**Flags**:
107110
- `--burns`: Also show history of burnt $WIT (either unwrapped to Witnet, or bridged to other EVM networks).
108-
- `--mints`: Also show history of minted $WIT (eiter wrapped from Witnet, or bridged from other EVM networks).
111+
- `--mints`: Also show history of minted $WIT (either wrapped from Witnet, or bridged from other EVM networks).
109112

110-
Options:
113+
**Options**:
111114
- `--limit`: Limit number of history records.
112115
- `--since`: Process events starting from the specified EVM block number.
113116
- `--from`: Filter transfers from the specified EVM address (required with when ordering a new transfer).
114117
- `--into`: Filter transfers to the specified EVM address (required when ordering a new transfer).
115118
- `--value`: Amount of $WIT to transfer between the specified addresses.
116119
- `--gasPrice`: Max. EVM gas price to pay when transferring $WIT.
117120

121+
---
118122
#### `$ witwrap wrappings`
119-
Shows the history of past wrapping transactions, as well as an up-to-date list with the status of on-going wrapping workflows. It also allows you to initiate a wrap transaction on Witnet, and validated on Ethereum when finalized.
123+
Shows the history of past wrapping transactions, as well as an up-to-date list with the status of on-going wrapping workflows. It also allows you to initiate a wrap transaction on Witnet, and validate it on Ethereum when finalized.
120124

121-
Flags:
122-
- `--check`: Show the time difference between the wrap transaction took place on Witnet, and when it gets ultimately verified on Ethereum.
125+
**Flags**:
126+
- `--check`: Show the time difference since the moment when the wrap transaction took place on Witnet, and when it got ultimately verified on Ethereum.
123127

124-
Options:
128+
**Options**:
125129
- `--limit`: Limit number of history records.
126130
- `--since`: Process events starting from the specified EVM block number.
127131
- `--from`: Filter wrappings from the specified WIT address (required when initiating a new wrap).
128132
- `--into`: Filter wrappings to the specified EVM address (required when initiating a new wrap).
129133
- `--value`: Amount of $WIT to be wrapped between the specified addresses.
130-
- `--vtt-hash`: Hash of some wrapping transaction that took place on Witnet to yet be verified on Ethereum.
134+
- `--vtt-hash`: Request the validation on Ethereum of some not-yet verified wrapping transaction that took place on Witnet.
131135
- `--gasPrice`: Max. EVM gas price to pay when querying the validation of some `--vtt-hash`.
132136

137+
---
133138
#### `$ witwrap unwrappings`
134-
Shows the history of past unwrapping transactions. It also allows you to unwrap $WIT tokens that you hold on any of the EVM proxy signing addresses, as long as you have enough $WIT balance and there's enough under-custody reserve supply on the ERC-20 contract.
139+
Shows the history of past unwrapping transactions. It also allows you to unwrap $WIT tokens that you hold on any of the EVM proxy signing addresses, as long as there's enough under-custody reserve supply on the ERC-20 contract.
135140

136-
Flags:
137-
- `--check`: Show the time difference between the unwrap transaction took place on Ethereum, and when the unwrapped amount gets ultimately transferred on Witnet.
141+
**Flags**:
142+
- `--check`: Show the time difference since the moment when the unwrap transaction took place on Ethereum, and the unwrapped amount got ultimately transferred to the recipient on Witnet.
138143

139-
Options:
144+
**Options**:
140145
- `--limit`: Limit number of history records.
141146
- `--since`: Process events starting from the specified EVM block number.
142147
- `--from`: Filter unwrappings from the specified EVM address (required when ordering a new unwrap).
@@ -147,12 +152,12 @@ Options:
147152
## 📄 Smart Contracts
148153
This repository includes the Solidity contracts that power the Ethereum side of the **Wrapped/WIT**, both on its canonical and Superchain-bridge versions.
149154

150-
Contracts are located in the `contracts/` directory:
155+
Contracts are located in the **contracts/** folder:
151156

152-
- `WrappedWIT.sol`
157+
- **WrappedWIT.sol**
153158
> The canonical version of the ERC-20 token contract for $WIT on Ethereum. It relies on the Wit/Oracle contract framework for validating both Proof-of-Reserve reports and cross-chain wrapping and unwrapping transactions.
154159
155-
- `WrappedWITSuperchain.sol`
160+
- **WrappedWITSuperchain.sol**
156161
> The "bridged" version of the ERC-20 token contract that allows wrapped $WIT tokens to be bridged out to a set of Superchain-compliant networks (see below). This version does not support wrapping nor unwrapping transactions with the Witnet network.
157162
158163
## 🧪 Supported Networks
@@ -170,22 +175,22 @@ Soon <sup>TM</sup>.
170175

171176
### Wrap 10,000.0 $WIT to Ethereum
172177
It involves a two-step workflow:
173-
- First, transfer 10,000.0 $WIT to the Wrapped/WIT custodian's address on Witnet:
178+
- First, transfer 10,000.0 $WIT to the Wrapped/WIT custodian's address in Witnet:
174179
- `witwrap wrappings --from <witnet_wallet_address> --into <evm_recipient> --value 10000.0`
175180
- Wait a few minutes until the value transfer gets finalized in Witnet.
176-
- Second, request the Wrapped/WIT to verify finality of the value transfer transaction in Witnet:
181+
- Second, request the Wrapped/WIT contract to verify finality of the value transfer transaction in Witnet:
177182
- `witwrap wrappings --vtt-hash <vtt_hash>`
178183
- Wait a few minutes until the Wit/Oracle on Ethereum validates the finality of the specified value transfer in Witnet.
179184
- You can at all times filter and check the status of pending wrapping transactions:
180185
- `witwrap wrappings [--from <witnet_wallet_addres>] [--into <evm_recipient>]`
181186

182-
Once the finality of the value transfer transaction that took place on Witnet gets verified in Ethereum, you shall see increased the $WIT balance of the specified `<evm_recipient>` address.
187+
Once the finality of the value transfer transaction that took place in Witnet gets verified in Ethereum, you shall see increased the $WIT balance of the specified `<evm_recipient>` address.
183188

184-
### Unwrap 500,0 $WIT to Witnet
189+
### Unwrap 500.0 $WIT to Witnet
185190
Just one single step required:
186191
- `witwrap unwrappings --from <evm_sender> --into <witnet_recipient> --value 500.0`
187192

188-
In a matter of a few seconds, you shall see increased the $WIT balance of the specified `<witnet_recipient>` address.
193+
In a matter of a few seconds, you should see increased the $WIT balance of the specified `<witnet_recipient>` address.
189194

190195
## 🔐 Security
191196
- **Do not share your private keys.**

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@witnet/wrapped-wit",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"author": "Witnet Foundation <info@witnet.foundation>",
55
"description": "Wrapped/WIT Solidity contracts and CLI tools",
66
"license": "MIT",

0 commit comments

Comments
 (0)