Skip to content

Commit 90228d9

Browse files
committed
docs: Add WASM adaptations guide and update README
1 parent 973d9cd commit 90228d9

File tree

2 files changed

+44
-0
lines changed

2 files changed

+44
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
Rust-Lightning
22
==============
33

4+
> **WASM Adaptation Notice**
5+
> This fork includes WebAssembly-specific changes.
6+
> See [adaptations guide](./WASM-ADAPTATIONS.md) for details.
7+
> ──────────────────────────────────
8+
49
[![Crate](https://img.shields.io/crates/v/lightning.svg?logo=rust)](https://crates.io/crates/lightning)
510
[![Documentation](https://img.shields.io/static/v1?logo=read-the-docs&label=docs.rs&message=lightning&color=informational)](https://docs.rs/lightning/)
611
[![Safety Dance](https://img.shields.io/badge/unsafe-forbidden-success.svg)](https://github.com/rust-secure-code/safety-dance/)

WASM-ADAPTATIONS.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# WASM Adaptations Guide
2+
3+
**Branch**: [`wasm-adapt`](https://github.com/utxostack/rust-lightning/tree/wasm-adapt)
4+
5+
## Core Modifications
6+
7+
```diff
8+
- use std::time::{SystemTime, UNIX_EPOCH, Instant};
9+
+ use lightning_common::{SystemTime, UNIX_EPOCH, Instant};
10+
```
11+
12+
## Scope
13+
14+
- Applies to all source files ​**except** test modules
15+
- Centralized in [`lightning-common`](./lightning-common/src/lib.rs) crate
16+
17+
---
18+
19+
## ​Maintenance Workflow
20+
21+
Upgrade Example (v0.0.125)
22+
23+
24+
1.**Rebase to upstream version**
25+
```bash
26+
git checkout wasm-adapt
27+
git rebase --onto v0.0.125
28+
```
29+
30+
2.**Verify adaptation integrity**
31+
32+
- Comprehensive code review to ensure that WASM-specific changes have not been missed
33+
- Perform necessary integration tests
34+
35+
3. **​Tag**
36+
37+
```bash
38+
git tag wasm-v0.0.125
39+
```

0 commit comments

Comments
 (0)