Skip to content

Commit 75b6728

Browse files
authored
Merge pull request #212 from nervosnetwork/update-doc-light-client-start
update: add doc for argument `networkSecretKey` in `LightClient.start`
2 parents 54a0bb7 + c92f3ac commit 75b6728

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

wasm/light-client-js/src/index.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ class LightClient {
4848
/**
4949
* Start the light client.
5050
* @param networkSetting Network setting for light-client-wasm. You can specify config if you are using mainnet or testnet. You must provide config and spec if you are using devnet.
51+
* @param networkSecretKey A secret key used to derive keys during data transport between nodes. This key should be persistent for a unique client.
5152
* @param logLevel Log Level for light-client-db-worker and light-client-wasm
5253
* @param transportType Specify transport type. `ws` stands for non-secure WebSocket, while `wss` stands for WebSocket over SSL.
5354
*/

0 commit comments

Comments
 (0)