github.com/kotalco/kotal@v0.3.0/clients/ethereum/types.go (about)

     1  package ethereum
     2  
     3  // Hyperledger Besu client arguments
     4  const (
     5  	// BesuLogging is the argument used for logging verbosity level
     6  	BesuLogging = "--logging"
     7  	// BesuNetworkID is the argument used for network id
     8  	BesuNetworkID = "--network-id"
     9  	// BesuNatMethod is the argument used for nat method
    10  	BesuNatMethod = "--nat-method"
    11  	// BesuNodePrivateKey is the argument used for node private key
    12  	BesuNodePrivateKey = "--node-private-key-file"
    13  	// BesuGenesisFile is the argument used for genesis file
    14  	BesuGenesisFile = "--genesis-file"
    15  	// BesuDataPath is the argument used for data path
    16  	BesuDataPath = "--data-path"
    17  	// BesuNetwork is the argument used for selecting network
    18  	BesuNetwork = "--network"
    19  	// BesuDiscoveryEnabled is the argument used to enabled discovery
    20  	BesuDiscoveryEnabled = "--discovery-enabled"
    21  	// BesuP2PPort is the argument used for p2p port
    22  	BesuP2PPort = "--p2p-port"
    23  	// BesuBootnodes is the argument used for bootnodes
    24  	BesuBootnodes = "--bootnodes"
    25  	// BesuSyncMode is the argument used for sync mode
    26  	BesuSyncMode = "--sync-mode"
    27  	// BesuMinerEnabled is the argument used for turning on mining
    28  	BesuMinerEnabled = "--miner-enabled"
    29  	// BesuMinerCoinbase is the argument used for setting coinbase account
    30  	BesuMinerCoinbase = "--miner-coinbase"
    31  	// BesuRPCHTTPCorsOrigins is the argument used for setting rpc HTTP cors origins
    32  	BesuRPCHTTPCorsOrigins = "--rpc-http-cors-origins"
    33  	// BesuRPCHTTPEnabled is the argument used to enable RPC over HTTP
    34  	BesuRPCHTTPEnabled = "--rpc-http-enabled"
    35  	// BesuRPCHTTPPort is the argument used for RPC HTTP port
    36  	BesuRPCHTTPPort = "--rpc-http-port"
    37  	// BesuRPCHTTPHost is the argument used for RPC HTTP Host
    38  	BesuRPCHTTPHost = "--rpc-http-host"
    39  	// BesuRPCHTTPAPI is the argument used for RPC HTTP APIs
    40  	BesuRPCHTTPAPI = "--rpc-http-api"
    41  
    42  	// BesuEngineRpcEnabled is the argument used to enable Engine RPC APIs
    43  	BesuEngineRpcEnabled = "--engine-rpc-enabled"
    44  	// BesuEngineJwtSecret is the argument used to locate JWT secret
    45  	BesuEngineJwtSecret = "--engine-jwt-secret"
    46  	// BesuEngineRpcPort is the argument used to set Engine RPC listening port
    47  	BesuEngineRpcPort = "--engine-rpc-port"
    48  	// BesuEngineHostAllowList is the argument used to set hosts from which to accept requests
    49  	BesuEngineHostAllowList = "--engine-host-allowlist"
    50  
    51  	// BesuRPCWSEnabled is the argument used to enable RPC WS
    52  	BesuRPCWSEnabled = "--rpc-ws-enabled"
    53  	// BesuRPCWSPort is the argument used for RPC WS port
    54  	BesuRPCWSPort = "--rpc-ws-port"
    55  	// BesuRPCWSHost is the argument used for RPC WS host
    56  	BesuRPCWSHost = "--rpc-ws-host"
    57  	// BesuRPCWSAPI is the argument used for RPC WS APIs
    58  	BesuRPCWSAPI = "--rpc-ws-api"
    59  	// BesuGraphQLHTTPEnabled is the argument used to enable QraphQL HTTP server
    60  	BesuGraphQLHTTPEnabled = "--graphql-http-enabled"
    61  	// BesuGraphQLHTTPPort is the argument used for GraphQL HTTP port
    62  	BesuGraphQLHTTPPort = "--graphql-http-port"
    63  	// BesuGraphQLHTTPHost is the argument used for GraphQL HTTP host
    64  	BesuGraphQLHTTPHost = "--graphql-http-host"
    65  	// BesuGraphQLHTTPCorsOrigins is the argument used for GraphQL HTTP Cors origins
    66  	BesuGraphQLHTTPCorsOrigins = "--graphql-http-cors-origins"
    67  	// BesuHostAllowlist is the argument used for whitelisting hosts
    68  	BesuHostAllowlist = "--host-allowlist"
    69  	// BesuStaticNodesFile is the argument used to locate static nodes file
    70  	BesuStaticNodesFile = "--static-nodes-file"
    71  )
    72  
    73  // Go ethereum client arguments
    74  const (
    75  	// GethLogging is the argument used for logging verbosity level
    76  	GethLogging = "--verbosity"
    77  	// GethConfig is the argument used for config file
    78  	GethConfig = "--config"
    79  	// GethNetworkID is the argument used for network id
    80  	GethNetworkID = "--networkid"
    81  	// GethNodeKey is the argument used for node private key
    82  	GethNodeKey = "--nodekey"
    83  	// GethNoDiscovery is the argument used to disable discovery
    84  	GethNoDiscovery = "--nodiscover"
    85  	// GethDataDir is the argument used for data path
    86  	GethDataDir = "--datadir"
    87  	// GethDisableIPC is the argument used to disable ipc servr
    88  	GethDisableIPC = "--ipcdisable"
    89  	// GethP2PPort is the argument used for p2p port
    90  	GethP2PPort = "--port"
    91  	// GethBootnodes is the argument used for bootnodes
    92  	GethBootnodes = "--bootnodes"
    93  	// GethSyncMode is the argument used for sync mode
    94  	GethSyncMode = "--syncmode"
    95  	// GethGcMode is the argument used for garbage collection mode
    96  	GethGcMode = "--gcmode"
    97  	// GethHistoryTxs is the argument used to set recent number of blocks to maintain transactions index for
    98  	GethHistoryTxs = "--history.transactions"
    99  	// GethCachePreImages is the argument used to enable recording the sha3 preimages of trie keys
   100  	GethCachePreImages = "--cache.preimages"
   101  
   102  	// GethMinerEnabled is the argument used for turning on mining
   103  	GethMinerEnabled = "--mine"
   104  	// GethMinerCoinbase is the argument used for setting coinbase account
   105  	GethMinerCoinbase = "--miner.etherbase"
   106  
   107  	// GethRPCHTTPCorsOrigins is the argument used for setting rpc HTTP cors origins
   108  	GethRPCHTTPCorsOrigins = "--http.corsdomain"
   109  	// GethRPCHTTPEnabled is the argument used to enable RPC over HTTP
   110  	GethRPCHTTPEnabled = "--http"
   111  	// GethRPCHTTPPort is the argument used for RPC HTTP port
   112  	GethRPCHTTPPort = "--http.port"
   113  	// GethRPCHTTPHost is the argument used for RPC HTTP Host
   114  	GethRPCHTTPHost = "--http.addr"
   115  	// GethRPCHTTPAPI is the argument used for RPC HTTP APIs
   116  	GethRPCHTTPAPI = "--http.api"
   117  	// GethRPCHostWhitelist is the argument used for whitelisting hosts
   118  	GethRPCHostWhitelist = "--http.vhosts"
   119  
   120  	// GethAuthRPCAddress is the argument used for listening address for authenticated APIs
   121  	GethAuthRPCAddress = "--authrpc.addr"
   122  	// GethAuthRPCPort is the argument used for listening port for authenticated APIs
   123  	GethAuthRPCPort = "--authrpc.port"
   124  	// GethAuthRPCHosts is the argument used for hostnames from which to accept requests
   125  	GethAuthRPCHosts = "--authrpc.vhosts"
   126  	// GethAuthRPCJwtSecret is the argument used for JWT secret to use for authenticated RPC endpoints
   127  	GethAuthRPCJwtSecret = "--authrpc.jwtsecret"
   128  
   129  	// --authrpc.jwtsecret
   130  
   131  	// GethRPCWSEnabled is the argument used to enable RPC WS
   132  	GethRPCWSEnabled = "--ws"
   133  	// GethRPCWSPort is the argument used for RPC WS port
   134  	GethRPCWSPort = "--ws.port"
   135  	// GethRPCWSHost is the argument used for RPC WS host
   136  	GethRPCWSHost = "--ws.addr"
   137  	// GethRPCWSAPI is the argument used for RPC WS APIs
   138  	GethRPCWSAPI = "--ws.api"
   139  	// GethWSOrigins is the argument used for RPC WS origins
   140  	GethWSOrigins = "--ws.origins"
   141  
   142  	// GethGraphQLHTTPEnabled is the argument used to enable QraphQL HTTP server
   143  	GethGraphQLHTTPEnabled = "--graphql"
   144  	// GethGraphQLHTTPCorsOrigins is the argument used for GraphQL HTTP Cors origins
   145  	GethGraphQLHTTPCorsOrigins = "--graphql.corsdomain"
   146  	// GethGraphQLHostWhitelist is the argument used for whitelisting hosts
   147  	GethGraphQLHostWhitelist = "--graphql.vhosts"
   148  	// GethUnlock is the argument used for unlocking imported ethereum account
   149  	GethUnlock = "--unlock"
   150  	// GethPassword is the argument used for locking imported ethereum address
   151  	GethPassword = "--password"
   152  )
   153  
   154  // Parity client arguments
   155  const (
   156  	// ParityLogging is the argument used for logging verbosity level
   157  	ParityLogging = "--logging"
   158  	// ParityNetworkID is the argument used for network id
   159  	ParityNetworkID = "--network-id"
   160  	// ParityNodeKey is the argument used for node key
   161  	ParityNodeKey = "--node-key"
   162  	// ParityDataDir is the argument used for data path
   163  	ParityDataDir = "--base-path"
   164  	// ParityReservedPeers is the argument used for static nodes (reserved peers)
   165  	ParityReservedPeers = "--reserved-peers"
   166  	// ParityNetwork is the argument used for selecting network
   167  	ParityNetwork = "--chain"
   168  	// ParityNoDiscovery is the argument used to disable discovery
   169  	ParityNoDiscovery = "--no-discovery"
   170  	// ParityP2PPort is the argument used for p2p port
   171  	ParityP2PPort = "--port"
   172  	// ParityBootnodes is the argument used for bootnodes
   173  	ParityBootnodes = "--bootnodes"
   174  	// ParitySyncMode is the argument used for sync mode
   175  	ParitySyncMode = "--pruning"
   176  	// ParityMinerCoinbase is the argument used for setting coinbase account
   177  	ParityMinerCoinbase = "--author"
   178  	// ParityEngineSigner is the argument used for engine singer
   179  	ParityEngineSigner = "--engine-signer"
   180  
   181  	// ParityDisableRPC is the argument used to disable JSON RPC HTTP server
   182  	ParityDisableRPC = "--no-jsonrpc"
   183  	// ParityRPCHTTPCorsOrigins is the argument used for setting rpc HTTP cors origins
   184  	ParityRPCHTTPCorsOrigins = "--jsonrpc-cors"
   185  	// ParityRPCHTTPPort is the argument used for RPC HTTP port
   186  	ParityRPCHTTPPort = "--jsonrpc-port"
   187  	// ParityRPCHTTPHost is the argument used for RPC HTTP Host
   188  	ParityRPCHTTPHost = "--jsonrpc-interface"
   189  	// ParityRPCHTTPAPI is the argument used for RPC HTTP APIs
   190  	ParityRPCHTTPAPI = "--jsonrpc-apis"
   191  	// ParityRPCHostWhitelist is the argument used for whitelisting hosts
   192  	ParityRPCHostWhitelist = "--jsonrpc-hosts"
   193  
   194  	// ParityDisableWS is the argument used for RPC WS port
   195  	ParityDisableWS = "--no-ws"
   196  	// ParityRPCWSCorsOrigins is the argument used for setting RPC WS cors origins
   197  	ParityRPCWSCorsOrigins = "--ws-origins"
   198  	// ParityRPCWSPort is the argument used for RPC WS port
   199  	ParityRPCWSPort = "--ws-port"
   200  	// ParityRPCWSHost is the argument used for RPC WS host
   201  	ParityRPCWSHost = "--ws-interface"
   202  	// ParityRPCWSAPI is the argument used for RPC WS APIs
   203  	ParityRPCWSAPI = "--ws-apis"
   204  	// ParityRPCWSWhitelist is the argument used for whitelisting hosts for WS server
   205  	ParityRPCWSWhitelist = "--ws-hosts"
   206  
   207  	// ParityUnlock is the argument used for unlocking imported ethereum account
   208  	ParityUnlock = "--unlock"
   209  	// ParityPassword is the argument used for locking imported ethereum address
   210  	ParityPassword = "--password"
   211  )
   212  
   213  // Nethermind client arguments
   214  const (
   215  	// NethermindLogging is the argument used for logging verbosity level
   216  	NethermindLogging = "--log"
   217  	// NethermindNodePrivateKey is the argument used for node private key
   218  	NethermindNodePrivateKey = "--KeyStore.EnodeKeyFile"
   219  	// NethermindStaticNodesFile is the argument used to locate static nodes file
   220  	NethermindStaticNodesFile = "--Init.StaticNodesPath"
   221  	// NethermindBootnodes is the argument used to set bootnodes
   222  	NethermindBootnodes = "--Discovery.Bootnodes"
   223  	// NethermindGenesisFile is the argument used for genesis file
   224  	NethermindGenesisFile = "--Init.ChainSpecPath"
   225  	// NethermindDataPath is the argument used for data path
   226  	NethermindDataPath = "--datadir"
   227  	// NethermindNetwork is the argument used for selecting network
   228  	NethermindNetwork = "--config"
   229  	// NethermindDiscoveryEnabled is the argument used to enabled discovery
   230  	NethermindDiscoveryEnabled = "--Init.DiscoveryEnabled"
   231  	// NethermindP2PPort is the argument used for p2p port
   232  	NethermindP2PPort = "--Network.P2PPort"
   233  	// NethermindFastSync is the argument used to enable beam sync
   234  	NethermindFastSync = "--Sync.FastSync"
   235  	// NethermindFastBlocks is the argument used to enable fast blocks sync
   236  	NethermindFastBlocks = "--Sync.FastBlocks"
   237  	// NethermindDownloadBodiesInFastSync is the argument used to enable downloading block bodies in fast sync
   238  	NethermindDownloadBodiesInFastSync = "--Sync.DownloadBodiesInFastSync"
   239  	// NethermindDownloadReceiptsInFastSync is the argument used to enable downloading block receipts in fast sync
   240  	NethermindDownloadReceiptsInFastSync = "--Sync.DownloadReceiptsInFastSync"
   241  	// NethermindDownloadHeadersInFastSync is the argument used to enable downloading block headers in fast sync
   242  	NethermindDownloadHeadersInFastSync = "--Sync.DownloadHeadersInFastSync"
   243  	// NethermindMinerCoinbase is the argument used for setting coinbase account
   244  	NethermindMinerCoinbase = "--KeyStore.BlockAuthorAccount"
   245  	// NethermindRPCHTTPEnabled is the argument used to enable RPC over HTTP
   246  	NethermindRPCHTTPEnabled = "--JsonRpc.Enabled"
   247  	// NethermindRPCHTTPHost is the argument used for RPC HTTP Host
   248  	NethermindRPCHTTPHost = "--JsonRpc.Host"
   249  	// NethermindRPCHTTPPort is the argument used for RPC HTTP port
   250  	NethermindRPCHTTPPort = "--JsonRpc.Port"
   251  	// NethermindRPCHTTPAPI is the argument used for RPC HTTP APIs
   252  	NethermindRPCHTTPAPI = "--JsonRpc.EnabledModules"
   253  
   254  	// NethermindRPCEnginePort is the argument used to set engine API listening port
   255  	NethermindRPCEnginePort = "--JsonRpc.EnginePort"
   256  	// NethermindRPCEngineHost is the argument used to set engine API listening address
   257  	NethermindRPCEngineHost = "--JsonRpc.EngineHost"
   258  	// NethermindRPCJwtSecretFile is the argument used to locate jwt secret file
   259  	NethermindRPCJwtSecretFile = "--JsonRpc.JwtSecretFile"
   260  
   261  	// NethermindRPCWSEnabled is the argument used to enable RPC WS
   262  	NethermindRPCWSEnabled = "--Init.WebSocketsEnabled"
   263  	// NethermindRPCWSPort is the argument used for RPC WS port
   264  	NethermindRPCWSPort = "--JsonRpc.WebSocketsPort"
   265  	// NethermindUnlockAccounts is the argument used to unlock accounts
   266  	NethermindUnlockAccounts = "--KeyStore.UnlockAccounts"
   267  	// NethermindPasswordFiles is the argument used locate password files for unlocked accounts
   268  	NethermindPasswordFiles = "--KeyStore.PasswordFiles"
   269  	// NethermindMiningEnabled is the argument used for turning on mining
   270  	NethermindMiningEnabled = "--Mining.Enabled"
   271  )