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: cmd/README.md
+16-1
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,8 @@
1
1
# /cmd
2
2
3
3
## Description
4
-
Contains the command-line interface (CLI) for the project
4
+
Contains the command-line interface (CLI) for the project.
5
+
Command-line interface for project is designed to help user to prepare and then run the service.
5
6
6
7
## Components
7
8
-`root.go`: Contains the main entry point for the CLI
@@ -12,6 +13,7 @@ Contains the command-line interface (CLI) for the project
12
13
Some of the commands require the mandatory or optional flags to be passed. See the [Flags](#flags) section for more details about specific flag definition and usage.
13
14
14
15
### Database Migrations
16
+
At the start of server user has to migrate up his db to have possibility to process deposits in right way.
15
17
Commands:
16
18
-`tss-svc service migrate up`: Migrates the database schema to the latest version
17
19
-`tss-svc service migrate down`: Rolls back the database schema to the previous version
@@ -20,6 +22,10 @@ Required flags:
20
22
-`--config` (can be omitted if the default config file path is used)
21
23
22
24
### Run server
25
+
Service can be run into two modes: keygen and signing.
26
+
- Signing mode offers user to take part in signing sessions and proceed incoming deposits.
27
+
- Keygen mode is designed to generate user`s shares used in signing process.
28
+
23
29
Commands:
24
30
-`tss-svc service run keygen`: Runs the TSS service in the keygen mode
25
31
-`tss-svc service run signing`: Runs the TSS service in the sign mode
@@ -54,6 +60,15 @@ Optional flags:
54
60
-`tss-svc helpers generate transaction`: Generates a new transaction based on the given data.
55
61
It is used for resharing purposes. Should be investigated further.
56
62
63
+
### Parsing
64
+
Commands:
65
+
-`tss-svc helpers parse address-btc [x-cord] [y-cord]`: Parses btc address from given point
66
+
-`tss-svc helpers parse address-eth [x-cord] [y-cord]`: Parses eth address from given point
67
+
-`tss-svc helpers parse pubkey [x-cord] [y-cord]`: Parses public key from given point
68
+
69
+
Optional flags:
70
+
-`--network` (Network type (mainnet/testnet), mainnet is used by default)
71
+
57
72
## Flags
58
73
-`--config` (`-c`): Specifies the path to the configuration file. By default, the config file path is set to `config.yaml`. See [Configuration](../docs/04_configuration.md) for more details
59
74
-`--output` (`-o`): Specifies the data output type for the command.
Copy file name to clipboardexpand all lines: internal/bridge/README.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ Signing data validation: using the provided deposit data and the signing data, t
71
71
72
72
### Zano network
73
73
Signing data construction: according to the provided deposit data, the [`emit_asset`](https://docs.zano.org/docs/build/rpc-api/wallet-rpc-api/emit_asset/) request is sent to the Zano wallet RPC server, and the resulting `VerifiedTxID` field is a ready-to-sign data.
74
-
74
+
75
75
Signing data validation: using the provided deposit data and provided additional data from the `emit_asset` response by the proposer, the constructor has the ability to decrypt transaction details using [`decrypt_tx_details`](https://docs.zano.org/docs/build/rpc-api/daemon-rpc-api/decrypt_tx_details) method.
76
76
Constructor validates:
77
77
- if the provided `VerifiedTxID` matches the `decrypt_tx_details` response;
0 commit comments