Skip to content

Commit e912542

Browse files
authored
README and minor theme type updates (#1811)
* better type names * update examples in README * default to mainnet * more work on readme, link to docs.wormhole.com * revert change * run testnet in local env by default
1 parent 9294247 commit e912542

File tree

11 files changed

+513
-454
lines changed

11 files changed

+513
-454
lines changed

CONTRIBUTING.md

+15-30
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,33 @@
11
## Contributing
22

3-
Contributions are welcome! To work on wormhole-connect locally you'll want to use `npm link` to make the changes to the SDK immediately available.
3+
Bug fixes and enhancements are welcome!
4+
5+
*Please don't open pull requests to add tokens to Connect.* Instead, use the `tokensConfig` parameter in `config` to add tokens into your deployment of Connect.
46

57
### Setup
68

79
1) Install
810

9-
Run `npm i` at the root of the repo
10-
11-
2) Build
12-
13-
Run `npm run build` at the root fo the repo
14-
15-
3) Start
1611

17-
Start wormhole-connect UI:
18-
```bash
19-
# in /wormhole-connect
20-
npm run start # testnet
2112
```
22-
23-
Start builder UI:
24-
```bash
25-
# in /builder
26-
npm run start
13+
npm i
2714
```
2815

29-
## Add a token
30-
31-
### Fill out token config
16+
2) Build SDK
3217

33-
1. Create an entry for the token in `wormhole-connect/config/<mainnet/testnet>.ts`.
34-
2. Ensure the `key` value is equal to the object key for easy lookup.
35-
3. Add decimal values for default, Ethereum, Solana and Sui if applicable (i.e. if they vary from the default value)
36-
4. If it's a native gas token, ensure that the wrapped version is also present and linked under `wrappedAsset`
18+
```
19+
cd sdk
20+
npm run build
21+
```
3722

38-
### Add a token icon
23+
3) Start demo app with Vite
3924

40-
1. Create a file under `icons/Tokens` labeled `<symbol>.tsx`.
41-
2. Create a React component and paste the svg in the return.
42-
3. Modify the svg to comply with react (mostly this is renaming attribute names with hyphens e.g. `view-box` to `viewBox`)
43-
4. Ensure the width and height attributes are present on the root `<svg>` element and max height and width are set (`style={{ maxHeight: '100%', maxWidth: '100%' }}`)
25+
```
26+
cd ../wormhole-connect
27+
npm run start
28+
```
4429

45-
## Setup
30+
This should start a local server at localhost:5173.
4631

4732
### Pre-commit hooks
4833

0 commit comments

Comments
 (0)