You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: examples/wallet/README.md
+40-21Lines changed: 40 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,27 +6,46 @@ This is a light wallet, it does not run its own node, and depends on one running
6
6
The node address will be configurable in the future 🙃
7
7
8
8
## development tools
9
-
*`npm run dev`: to run the app with a debugger
10
-
*`npm run lint`: lint js files with eslint
11
-
*`npm run lint-styles`: lint css files with stylelint
12
-
*`npm run flow`: check [flow](https://flow.org/) type annotations
9
+
10
+
-`yarn install`: install dependencies
11
+
-`yarn dev`: to run the app with a debugger
12
+
-`yarn lint`: lint js files with eslint
13
+
-`yarn lint-styles`: lint css files with stylelint
14
+
-`yarn flow`: check [flow](https://flow.org/) type annotations
15
+
16
+
To run the application in development mode, first install the dependencies with
17
+
`yarn install` and then run it with `yarn dev`.
18
+
19
+
To build an appimage package, first install the dependencies with
20
+
`yarn install` and then package the app with `yarn package-{linux,win}`
13
21
14
22
## TODO
23
+
15
24
-[ x ] show the balance of a given address
16
-
-[] verify the validity of an address before making a request to the a node (js bindings will be added here, ideally, before tackling any more complex issues such as creating transactione)
17
-
-[] let the user use its private key.
18
-
-[] prompt the user for its private key, ideally locking parts of the app until a valid one is inserted
19
-
-[] bip39?
20
-
-[] send account-based transactions
21
-
-[] UI
22
-
-[] verify validity of the recipient's address
23
-
-[] update sender's account counter
24
-
-[] generate transaction
25
-
-[] add output
26
-
-[] add witness
27
-
-[] broadcast transaction
28
-
-[] locally store the user's private key
29
-
-[] define a password schema for unlocking the app (so the funds are secure if the user's device is used by someone else)
30
-
-[] define a password schema for encrypting the private keys(so the funds are secure if the device's storage is compromised)
31
-
-[] view mode?
32
-
-[] list user transactions and their status?
25
+
-[ ] verify the validity of an address before making a request to the a node (js bindings will be added here, ideally, before tackling any more complex issues such as creating transactione)
26
+
-[ x ] add js-chain-libs bindings
27
+
-[ ] handle errors in address format
28
+
-[ ] let the user use its private key.
29
+
-[ ] prompt the user for its private key, ideally locking parts of the app until a valid one is inserted
30
+
-[ ] bip39?
31
+
-[ ] send account-based transactions
32
+
-[ ] UI
33
+
-[ ] verify validity of the recipient's address
34
+
-[ ] update sender's account counter
35
+
-[ ] generate transaction
36
+
-[ ] add output
37
+
-[ ] add witness
38
+
-[ ] broadcast transaction
39
+
-[ ] locally store the user's private key
40
+
-[ ] define a password schema for unlocking the app (so the funds are secure if the user's device is used by someone else)
41
+
-[ ] define a password schema for encrypting the private keys(so the funds are secure if the device's storage is compromised)
42
+
-[ ] view mode?
43
+
-[ ] list user transactions and their status?
44
+
45
+
## Tech debt
46
+
47
+
-[ ] extract flow types from the js-chain-libs with [flowtype](https://github.com/joarwilk/flowgen), and have a module that exports them and abstracts the initialization of the wasm
48
+
-[ ] research: Is the mechanism for importing wasm smart enough to not load it
49
+
several times into memory if it is imported in more than one place?
50
+
-[ ] if it is not, have the aforementioned module take care of
0 commit comments