Skip to content

Commit 173e532

Browse files
authored
Changes for repo migration (#35)
* update: change stuff to refraction-network and minor fixes * remove link to archived repo * ignore Cargo.lock in crates
1 parent 284ed24 commit 173e532

File tree

12 files changed

+29
-3052
lines changed

12 files changed

+29
-3052
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ target
33
.DS_Store
44
.vscode
55
Cargo.lock
6+
crates/*/Cargo.lock

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# W.A.T.E.R.: WebAssembly Transport Executables Runtime
2-
![GitHub License](https://img.shields.io/github/license/erikziyunchi/water-rs)
3-
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Ferikziyunchi%2Fwater-rs.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Ferikziyunchi%2Fwater-rs?ref=badge_shield&issueType=license) [![Build & Test Status](https://github.com/erikziyunchi/WASMable-Transport/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/erikziyunchi/WASMable-Transport/actions/workflows/rust.yml)
2+
![GitHub License](https://img.shields.io/github/license/refraction-networking/water-rs)
3+
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Frefraction-networking%2Fwater-rs.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Frefraction-networking%2Fwater-rs?ref=badge_shield&issueType=license)
4+
[![Build & Test Status](https://github.com/refraction-networking/water-rs/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/refraction-networking/water-rs/actions/workflows/rust.yml)
45

56
<div style="width: 100%; height = 160px">
67
<div style="width: 75%; height: 150px; float: left;">
@@ -12,29 +13,28 @@
1213
</div>
1314
</div>
1415

15-
The Go implementation of the runtime library can be found in [water-go](https://github.com/gaukas/water). We now also support building WATM in Go, please refer to [watm](https://github.com/gaukas/watm) for examples and helper libraries interfacing Pluggable Transports-like interfaces. Official Go compiler is currently not supported ([watm#4](https://github.com/gaukas/watm/issues/4)).
16+
The Go implementation of the runtime library can be found in [water-go](https://github.com/refraction-networking/water). We now also support building WATM in Go, please refer to [watm](https://github.com/refraction-networking/watm) for examples and helper libraries interfacing Pluggable Transports-like interfaces. Official Go compiler is currently not supported until further notice.
1617

1718
### Cite our work
1819

19-
If you quoted or used our work in your own project/paper/research, please cite our paper [Just add WATER: WebAssembly-based Circumvention Transports](https://arxiv.org/pdf/2312.00163.pdf).
20+
If you quoted or used our work in your own project/paper/research, please cite our paper [Just add WATER: WebAssembly-based Circumvention Transports](https://www.petsymposium.org/foci/2024/foci-2024-0003.pdf), which is published in the proceedings of Free and Open Communications on the Internet (FOCI) in 2024 issue 1, pages 22-28.
2021

2122
<details>
2223
<summary>BibTeX</summary>
2324

2425
```bibtex
2526
@inproceedings{water-foci24,
26-
author = {Chi, Erik and Wang, Gaukas and Halderman, J. Alex and Wustrow, Eric and Wampler, Jack},
27-
year = {2024},
28-
month = {02},
29-
title = {Just add {WATER}: {WebAssembly}-based Circumvention Transports},
30-
address = {Virtual Event},
31-
series = {FOCI '24},
32-
booktitle = {Free and Open Communications on the Internet},
27+
author = {Erik Chi and Gaukas Wang and J. Alex Halderman and Eric Wustrow and Jack Wampler},
28+
title = {Just add {WATER}: {WebAssembly}-based Circumvention Transports},
29+
booktitle = {Free and Open Communications on the Internet},
30+
publisher = {},
31+
year = {2024},
32+
url = {https://www.petsymposium.org/foci/2024/foci-2024-0003.pdf},
3333
}
3434
```
3535
</details>
3636

37-
**Update**: our paper has been accepted by FOCI and will appear at [FOCI 2024](https://foci.community/foci24.html) on Feb 19, 2024!
37+
**Update**: our paper has been accepted by FOCI and presented at [FOCI 2024](https://foci.community/foci24.html)!
3838

3939
## Be Water
4040

@@ -45,14 +45,14 @@ If you quoted or used our work in your own project/paper/research, please cite o
4545
## Contents
4646

4747
The repo contains 2 main components:
48-
1. A Rust crate [`water`](https://github.com/erikziyunchi/water-rs/tree/main/crates/water) runtime library used to interact with `.wasm` WebAssembly Transport Modules(WATM).
49-
2. A Rust crate [`watm_v0`](https://github.com/erikziyunchi/water-rs/tree/main/crates/watm_v0) for the v0 WATM-development where developers can easily create their own `.wasm` (the general version of `watm` is still under development).
48+
1. A Rust crate [`water`](https://github.com/refraction-networking/water-rs/tree/main/crates/water) runtime library used to interact with `.wasm` WebAssembly Transport Modules(WATM).
49+
2. A Rust crate [`watm_v0`](https://github.com/refraction-networking/water-rs/tree/main/crates/watm_v0) for the v0 WATM-development where developers can easily create their own `.wasm` (the general version of `watm` is still under development).
5050

5151

5252
Also include examples for demonstration of usage:
53-
1. ⭐ A standalone [`cli`](https://github.com/erikziyunchi/water-rs/tree/main/examples/clients/cli) tool which is compatible with both `v0` and `v1_preview`, and can run all different roles with all of our example WATM binaries.
54-
2. A few examples WATM implementations with `water_wasm` crate, see [water-rs/tree/main/examples/water_bins](https://github.com/erikziyunchi/water-rs/tree/main/examples/water_bins).
55-
3. Examples of using the above WATM examples with our `water` library, see [tests](https://github.com/erikziyunchi/water-rs/tree/main/tests/tests) for usage.
53+
1. ⭐ A standalone [`cli`](https://github.com/refraction-networking/water-rs/tree/main/examples/clients/cli) tool which is compatible with both `v0` and `v1_preview`, and can run all different roles with all of our example WATM binaries.
54+
2. A few examples WATM implementations with `water_wasm` crate, see [water-rs/tree/main/examples/water_bins](https://github.com/refraction-networking/water-rs/tree/main/examples/water_bins).
55+
3. Examples of using the above WATM examples with our `water` library, see [tests](https://github.com/refraction-networking/water-rs/tree/main/tests/tests) for usage.
5656

5757
## Running tests
5858

0 commit comments

Comments
 (0)