moneysurfer 0.1.1 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +11 -5
  2. package/dist/cli.js +583 -315
  3. package/package.json +9 -11
package/README.md CHANGED
@@ -8,13 +8,14 @@ moneysurfer [v1|v2] <command> ...
8
8
 
9
9
  ## Features
10
10
 
11
- - Full V1 and V2 support: V1 on Ethereum, Optimism and Arbitrum; V2 on mainnet
11
+ - Full V1 and V2 support: V1 on Ethereum, Optimism and Arbitrum; V2 on Ethereum and BNB Chain
12
12
  - One seed per protocol
13
- - Nothing is sent to the ASP
13
+ - Nothing is sent to the ASP; its set is read from the chain
14
14
  - Withdraw via a relayer, yourself, or a Safe; ragequit if unapproved
15
15
  - Local prover in pure JS, everything simulated before sending
16
16
  - Sign with Frame, a private key or a keystore
17
- - No build step, minimal and security audited dependencies
17
+ - Minimal and security audited dependencies, bundled in: an install adds one package
18
+ - Node runs the sources as they are; only the published bundle is built
18
19
 
19
20
  ## Install
20
21
 
@@ -45,7 +46,9 @@ A deposit can be withdrawn once the ASP approves it (up to 7 days); until then
45
46
 
46
47
  ### V2
47
48
 
48
- Relayed withdrawals are not supported for v2 yet.
49
+ A withdrawal goes through 0xbow's relayer, which pays the gas and takes its fee out of
50
+ `<amount>`. With `--self` or `--safe` you submit it instead, and then `<to>` has to be the
51
+ submitter: the pool pays `msg.sender`, and only a relayer's contract splits the payout.
49
52
 
50
53
  ```sh
51
54
  moneysurfer v2 setup
@@ -53,9 +56,12 @@ moneysurfer v2 init # --from-wallet derives the seed the app woul
53
56
  moneysurfer v2 register # a Keystore leaf; required before spending
54
57
  moneysurfer v2 pools
55
58
  moneysurfer v2 deposit usdc 10.02
56
- moneysurfer v2 withdraw ppusdc 5 0xRecipient --self
59
+ moneysurfer v2 withdraw ppusdc 5 0xRecipient
57
60
  ```
58
61
 
62
+ `--chain bnb` uses BNB Chain, with a seed's notes kept apart from its mainnet ones. It needs
63
+ `--rpc-url`: no public BNB Chain RPC serves the logs a sync reads.
64
+
59
65
  Run `moneysurfer help` for all commands and options.
60
66
 
61
67
  ## License