/
doc.go
163 lines (154 loc) · 12.2 KB
/
doc.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
package paths
import "fmt"
const (
// LongestPathNameLen is the length of the longest path name. It is used
// for text formatting.
LongestPathNameLen = 35
)
type ListPathsResponse struct {
CachePaths map[string]string `json:"cachePaths"`
ConfigPaths map[string]string `json:"configPaths"`
DataPaths map[string]string `json:"dataPaths"`
StatePaths map[string]string `json:"statePaths"`
}
func List(vegaPaths Paths) *ListPathsResponse {
// Some files don't support custom vega home. So we need the default anyway.
defaultPath := New("")
return &ListPathsResponse{
CachePaths: map[string]string{
"DataNodeCacheHome": vegaPaths.CachePathFor(DataNodeCacheHome),
},
ConfigPaths: map[string]string{
"DataNodeConfigHome": vegaPaths.ConfigPathFor(DataNodeConfigHome),
"DataNodeDefaultConfigFile": vegaPaths.ConfigPathFor(DataNodeDefaultConfigFile),
"FaucetConfigHome": vegaPaths.ConfigPathFor(FaucetConfigHome),
"FaucetDefaultConfigFile": vegaPaths.ConfigPathFor(FaucetDefaultConfigFile),
"NodeConfigHome": vegaPaths.ConfigPathFor(NodeConfigHome),
"NodeDefaultConfigFile": vegaPaths.ConfigPathFor(NodeDefaultConfigFile),
"NodeWalletsConfigFile": vegaPaths.ConfigPathFor(NodeWalletsConfigFile),
"WalletCLIConfigHome": vegaPaths.ConfigPathFor(WalletCLIConfigHome),
"WalletCLIDefaultConfigFile": vegaPaths.ConfigPathFor(WalletCLIDefaultConfigFile),
"WalletAppConfigHome": defaultPath.ConfigPathFor(WalletAppConfigHome),
"WalletAppFairgroundConfigFile": defaultPath.ConfigPathFor(WalletAppFairgroundConfigFile),
"WalletAppDefaultConfigFile": defaultPath.ConfigPathFor(WalletAppDefaultConfigFile),
"WalletServiceConfigHome": vegaPaths.ConfigPathFor(WalletServiceConfigHome),
"WalletServiceDefaultConfigFile": vegaPaths.ConfigPathFor(WalletServiceDefaultConfigFile),
"WalletServiceNetworksConfigHome": vegaPaths.ConfigPathFor(WalletServiceNetworksConfigHome),
},
DataPaths: map[string]string{
"NodeDataHome": vegaPaths.DataPathFor(NodeDataHome),
"NodeWalletsDataHome": vegaPaths.DataPathFor(NodeWalletsDataHome),
"VegaNodeWalletsDataHome": vegaPaths.DataPathFor(VegaNodeWalletsDataHome),
"EthereumNodeWalletsDataHome": vegaPaths.DataPathFor(EthereumNodeWalletsDataHome),
"FaucetDataHome": vegaPaths.DataPathFor(FaucetDataHome),
"FaucetWalletsDataHome": vegaPaths.DataPathFor(FaucetWalletsDataHome),
"WalletsDataHome": vegaPaths.DataPathFor(WalletsDataHome),
"WalletServiceDataHome": vegaPaths.DataPathFor(WalletServiceDataHome),
"WalletServiceAPITokensDataFile": vegaPaths.DataPathFor(WalletServiceAPITokensDataFile),
"WalletServiceSessionTokensDataFile": vegaPaths.DataPathFor(WalletServiceSessionTokensDataFile),
"WalletServiceRSAKeysDataHome": vegaPaths.DataPathFor(WalletServiceRSAKeysDataHome),
"WalletServicePublicRSAKeyDataFile": vegaPaths.DataPathFor(WalletServicePublicRSAKeyDataFile),
"WalletServicePrivateRSAKeyDataFile": vegaPaths.DataPathFor(WalletServicePrivateRSAKeyDataFile),
},
StatePaths: map[string]string{
"DataNodeStateHome": vegaPaths.StatePathFor(DataNodeStateHome),
"DataNodeAutoCertHome": vegaPaths.StatePathFor(DataNodeAutoCertHome),
"DataNodeLogsHome": vegaPaths.StatePathFor(DataNodeLogsHome),
"DataNodeStorageHome": vegaPaths.StatePathFor(DataNodeStorageHome),
"DataNodeStorageSQLStoreHome": vegaPaths.StatePathFor(DataNodeStorageSQLStoreHome),
"DataNodeStorageSQLStoreNodeDataHome": vegaPaths.StatePathFor(DataNodeStorageSQLStoreNodeDataHome),
"DataNodeEmbeddedPostgresRuntimeDir": vegaPaths.StatePathFor(DataNodeEmbeddedPostgresRuntimeDir),
"DataNodeNetworkHistoryHome": vegaPaths.StatePathFor(DataNodeNetworkHistoryHome),
"DataNodeNetworkHistorySnapshotCopyTo": vegaPaths.StatePathFor(DataNodeNetworkHistorySnapshotCopyTo),
"DataNodeNetworkHistorySnapshotCopyFrom": vegaPaths.StatePathFor(DataNodeNetworkHistorySnapshotCopyFrom),
"DataNodeEventBufferHome": vegaPaths.StatePathFor(DataNodeEventBufferHome),
"DataNodeArchivedEventBufferHome": vegaPaths.StatePathFor(DataNodeArchivedEventBufferHome),
"NodeStateHome": vegaPaths.StatePathFor(NodeStateHome),
"NodeLogsHome": vegaPaths.StatePathFor(NodeLogsHome),
"CheckpointStateHome": vegaPaths.StatePathFor(CheckpointStateHome),
"SnapshotStateHome": vegaPaths.StatePathFor(SnapshotStateHome),
"SnapshotDBStateFile": vegaPaths.StatePathFor(SnapshotDBStateFile),
"SnapshotMetadataDBStateFile": vegaPaths.StatePathFor(SnapshotMetadataDBStateFile),
"WalletCLIStateHome": vegaPaths.StatePathFor(WalletCLIStateHome),
"WalletCLILogsHome": vegaPaths.StatePathFor(WalletCLILogsHome),
"WalletAppStateHome": vegaPaths.StatePathFor(WalletAppStateHome),
"WalletAppLogsHome": vegaPaths.StatePathFor(WalletAppLogsHome),
"WalletServiceStateHome": vegaPaths.StatePathFor(WalletServiceStateHome),
"WalletServiceLogsHome": vegaPaths.StatePathFor(WalletServiceLogsHome),
},
}
}
func Explain(name string) (string, error) {
paths := map[string]string{
"DataNodeCacheHome": `This folder contains the cache used by the data-node.`,
"DataNodeConfigHome": `This folder contains the configuration files used by the data-node.`,
"DataNodeDefaultConfigFile": `This file contains the configuration used by the data-node.`,
"FaucetConfigHome": `This folder contains the configuration files used by the faucet.`,
"FaucetDefaultConfigFile": `This file contains the configuration used by the faucet.`,
"NodeConfigHome": `This folder contains the configuration files used by the node.`,
"NodeDefaultConfigFile": `This file contains the configuration used by the node.`,
"NodeWalletsConfigFile": `This file contains information related to the registered node's wallets used by the node.`,
"WalletCLIConfigHome": `This folder contains the configuration files used by the wallet-cli.`,
"WalletCLIDefaultConfigFile": `This file contains the configuration used by the wallet-cli.`,
"WalletAppConfigHome": `This folder contains the configuration files used by the wallet-app.`,
"WalletAppFairgroundConfigFile": `This file contains the Fairground configuration used by the wallet-app.`,
"WalletAppDefaultConfigFile": `This file contains the default configuration used by the wallet-app.`,
"WalletServiceConfigHome": `This folder contains the configuration files used by the wallet's service.`,
"WalletServiceDefaultConfigFile": `This file contains the configuration used by the wallet service.`,
"WalletServiceNetworksConfigHome": `This folder contains the network configuration files used by the wallet's service.`,
"NodeDataHome": `This folder contains the data managed by the node.`,
"NodeWalletsDataHome": `This folder contains the data managed by the node's wallets.`,
"VegaNodeWalletsDataHome": `This folder contains the Vega wallet registered as node's wallet, used by the node to sign Vega commands.`,
"EthereumNodeWalletsDataHome": `This folder contains the Ethereum wallet registered as node's wallet, used by the node to interact with the Ethereum blockchain.`,
"FaucetDataHome": `This folder contains the data used by the faucet.`,
"FaucetWalletsDataHome": `This folder contains the Vega wallet used by the faucet to sign its deposit commands.`,
"WalletsDataHome": `This folder contains the "user's" wallets. These wallets are used by the user to issue commands to a Vega network.`,
"WalletServiceDataHome": `This folder contains the data used by the wallet's service.`,
"WalletServiceRSAKeysDataHome": `This folder contains the RSA keys used by the wallet's service for authentication.`,
"WalletServicePublicRSAKeyDataFile": `This file contains the public RSA key used by the wallet's service for authentication.`,
"WalletServicePrivateRSAKeyDataFile": `This file contains the private RSA key used by the wallet's service for authentication.`,
"DataNodeStateHome": `This folder contains the state files used by the data-node.`,
"DataNodeAutoCertHome": `This folder contains the autogenerated SSL certificates.`,
"DataNodeLogsHome": `This folder contains the log files generated by the data-node.`,
"DataNodeStorageHome": `This folder contains the consolidated state, built out of the Vega network events, and served by the data-node's API.`,
"DataNodeStorageSQLStoreHome": `This folder contains the files generated by the embedded Postgres database.`,
"DataNodeStorageSQLStoreNodeDataHome": `This folder contains the data files generated by the embedded Postgres database.`,
"DataNodeEmbeddedPostgresRuntimeDir": `This folder contains the files used at runtime by the embedded Postgres database.`,
"DataNodeNetworkHistoryHome": `This folder contains the network history data.`,
"DataNodeNetworkHistorySnapshotCopyTo": `This folder contains the snapshots created by the datanode.`,
"DataNodeNetworkHistorySnapshotCopyFrom": `This folder contains the snapshots read by the datanode.`,
"DataNodeEventBufferHome": `This folder contains the event buffer files.`,
"DataNodeArchivedEventBufferHome": `This folder contains the archived event buffer files.`,
"NodeStateHome": `This folder contains the state files used by the node.`,
"NodeLogsHome": `This folder contains the log files generated by the node.`,
"CheckpointStateHome": `This folder contains the network checkpoints generated by the node.`,
"SnapshotStateHome": `This folder contains the Tendermint snapshots of the application state generated by the node.`,
"SnapshotDBStateFile": `This file is a database containing the snapshots' data of the of the application state generated by the node`,
"SnapshotMetadataDBStateFile": `This file is a database containing the metadata about the application snapshots`,
"WalletCLIStateHome": `This folder contains the state files used by the wallet-cli.`,
"WalletCLILogsHome": `This folder contains the log files generated by the wallet-cli.`,
"WalletAppStateHome": `This folder contains the state files used by the wallet-app.`,
"WalletAppLogsHome": `This folder contains the log files generated by the wallet-app.`,
"WalletServiceStateHome": `This folder contains the state files used by the wallet's service.`,
"WalletServiceLogsHome": `This folder contains the log files generated by the wallet's service'.`,
}
description, ok := paths[name]
if !ok {
return "", fmt.Errorf("path \"%s\" has no documentation", name)
}
return description, nil
}