status-im
/
nimbus-eth1
mirror of https://github.com/status-im/nimbus-eth1.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Change Waku RPC methods prefix

This commit is contained in:
kdeme 2020-01-20 18:01:18 +01:00 committed by zah
parent d56655d278
commit ca6890b026
3 changed files with 56 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
nimbus/rpc/waku.nim
View File

@ -10,11 +10,11 @@ from stew/byteutils import hexToSeqByte, hexToByteArray
proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) = proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
rpcsrv.rpc("shh_version") do() -> string: rpcsrv.rpc("waku_version") do() -> string:
## Returns string of the current whisper protocol version. ## Returns string of the current whisper protocol version.
result = wakuVersionStr result = wakuVersionStr
rpcsrv.rpc("shh_info") do() -> WhisperInfo: rpcsrv.rpc("waku_info") do() -> WhisperInfo:
## Returns diagnostic information about the whisper node. ## Returns diagnostic information about the whisper node.
let config = node.protocolState(Waku).config let config = node.protocolState(Waku).config
result = WhisperInfo(minPow: config.powRequirement, result = WhisperInfo(minPow: config.powRequirement,
@ -23,7 +23,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
messages: 0) messages: 0)
# TODO: uint32 instead of uint64 is OK here, but needs to be added in json_rpc # TODO: uint32 instead of uint64 is OK here, but needs to be added in json_rpc
rpcsrv.rpc("shh_setMaxMessageSize") do(size: uint64) -> bool: rpcsrv.rpc("waku_setMaxMessageSize") do(size: uint64) -> bool:
## Sets the maximal message size allowed by this node. ## Sets the maximal message size allowed by this node.
## Incoming and outgoing messages with a larger size will be rejected. ## Incoming and outgoing messages with a larger size will be rejected.
## Whisper message size can never exceed the limit imposed by the underlying ## Whisper message size can never exceed the limit imposed by the underlying
@ -36,7 +36,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
if not result: if not result:
raise newException(ValueError, "Invalid size") raise newException(ValueError, "Invalid size")
rpcsrv.rpc("shh_setMinPoW") do(pow: float) -> bool: rpcsrv.rpc("waku_setMinPoW") do(pow: float) -> bool:
## Sets the minimal PoW required by this node. ## Sets the minimal PoW required by this node.
## ##
## pow: The new PoW requirement. ## pow: The new PoW requirement.
@ -48,7 +48,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
result = true result = true
# TODO: change string in to ENodeStr with extra checks # TODO: change string in to ENodeStr with extra checks
rpcsrv.rpc("shh_markTrustedPeer") do(enode: string) -> bool: rpcsrv.rpc("waku_markTrustedPeer") do(enode: string) -> bool:
## Marks specific peer trusted, which will allow it to send historic ## Marks specific peer trusted, which will allow it to send historic
## (expired) messages. ## (expired) messages.
## Note: This function is not adding new nodes, the node needs to exists as ## Note: This function is not adding new nodes, the node needs to exists as
@ -64,7 +64,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
if not result: if not result:
raise newException(ValueError, "Not a peer") raise newException(ValueError, "Not a peer")
rpcsrv.rpc("shh_newKeyPair") do() -> Identifier: rpcsrv.rpc("waku_newKeyPair") do() -> Identifier:
## Generates a new public and private key pair for message decryption and ## Generates a new public and private key pair for message decryption and
## encryption. ## encryption.
## ##
@ -72,7 +72,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
result = generateRandomID().Identifier result = generateRandomID().Identifier
keys.asymKeys.add(result.string, newKeyPair()) keys.asymKeys.add(result.string, newKeyPair())
rpcsrv.rpc("shh_addPrivateKey") do(key: PrivateKey) -> Identifier: rpcsrv.rpc("waku_addPrivateKey") do(key: PrivateKey) -> Identifier:
## Stores the key pair, and returns its ID. ## Stores the key pair, and returns its ID.
## ##
## key: Private key as hex bytes. ## key: Private key as hex bytes.
@ -83,7 +83,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
keys.asymKeys.add(result.string, KeyPair(seckey: key, keys.asymKeys.add(result.string, KeyPair(seckey: key,
pubkey: key.getPublicKey())) pubkey: key.getPublicKey()))
rpcsrv.rpc("shh_deleteKeyPair") do(id: Identifier) -> bool: rpcsrv.rpc("waku_deleteKeyPair") do(id: Identifier) -> bool:
## Deletes the specifies key if it exists. ## Deletes the specifies key if it exists.
## ##
## id: Identifier of key pair ## id: Identifier of key pair
@ -94,7 +94,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
if not result: if not result:
raise newException(ValueError, "Invalid key id") raise newException(ValueError, "Invalid key id")
rpcsrv.rpc("shh_hasKeyPair") do(id: Identifier) -> bool: rpcsrv.rpc("waku_hasKeyPair") do(id: Identifier) -> bool:
## Checks if the whisper node has a private key of a key pair matching the ## Checks if the whisper node has a private key of a key pair matching the
## given ID. ## given ID.
## ##
@ -103,7 +103,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
## Returns (true or false) on success and an error on failure. ## Returns (true or false) on success and an error on failure.
result = keys.asymkeys.hasKey(id.string) result = keys.asymkeys.hasKey(id.string)
rpcsrv.rpc("shh_getPublicKey") do(id: Identifier) -> PublicKey: rpcsrv.rpc("waku_getPublicKey") do(id: Identifier) -> PublicKey:
## Returns the public key for identity ID. ## Returns the public key for identity ID.
## ##
## id: Identifier of key pair ## id: Identifier of key pair
@ -112,7 +112,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
# Note: key not found exception as error in case not existing # Note: key not found exception as error in case not existing
result = keys.asymkeys[id.string].pubkey result = keys.asymkeys[id.string].pubkey
rpcsrv.rpc("shh_getPrivateKey") do(id: Identifier) -> PrivateKey: rpcsrv.rpc("waku_getPrivateKey") do(id: Identifier) -> PrivateKey:
## Returns the private key for identity ID. ## Returns the private key for identity ID.
## ##
## id: Identifier of key pair ## id: Identifier of key pair
@ -121,7 +121,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
# Note: key not found exception as error in case not existing # Note: key not found exception as error in case not existing
result = keys.asymkeys[id.string].seckey result = keys.asymkeys[id.string].seckey
rpcsrv.rpc("shh_newSymKey") do() -> Identifier: rpcsrv.rpc("waku_newSymKey") do() -> Identifier:
## Generates a random symmetric key and stores it under an ID, which is then ## Generates a random symmetric key and stores it under an ID, which is then
## returned. Can be used encrypting and decrypting messages where the key is ## returned. Can be used encrypting and decrypting messages where the key is
## known to both parties. ## known to both parties.
@ -135,7 +135,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
keys.symKeys.add(result.string, key) keys.symKeys.add(result.string, key)
rpcsrv.rpc("shh_addSymKey") do(key: SymKey) -> Identifier: rpcsrv.rpc("waku_addSymKey") do(key: SymKey) -> Identifier:
## Stores the key, and returns its ID. ## Stores the key, and returns its ID.
## ##
## key: The raw key for symmetric encryption as hex bytes. ## key: The raw key for symmetric encryption as hex bytes.
@ -145,7 +145,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
keys.symKeys.add(result.string, key) keys.symKeys.add(result.string, key)
rpcsrv.rpc("shh_generateSymKeyFromPassword") do(password: string) -> Identifier: rpcsrv.rpc("waku_generateSymKeyFromPassword") do(password: string) -> Identifier:
## Generates the key from password, stores it, and returns its ID. ## Generates the key from password, stores it, and returns its ID.
## ##
## password: Password. ## password: Password.
@ -162,7 +162,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
result = generateRandomID().Identifier result = generateRandomID().Identifier
keys.symKeys.add(result.string, symKey) keys.symKeys.add(result.string, symKey)
rpcsrv.rpc("shh_hasSymKey") do(id: Identifier) -> bool: rpcsrv.rpc("waku_hasSymKey") do(id: Identifier) -> bool:
## Returns true if there is a key associated with the name string. ## Returns true if there is a key associated with the name string.
## Otherwise, returns false. ## Otherwise, returns false.
## ##
@ -171,7 +171,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
## Returns (true or false) on success and an error on failure. ## Returns (true or false) on success and an error on failure.
result = keys.symkeys.hasKey(id.string) result = keys.symkeys.hasKey(id.string)
rpcsrv.rpc("shh_getSymKey") do(id: Identifier) -> SymKey: rpcsrv.rpc("waku_getSymKey") do(id: Identifier) -> SymKey:
## Returns the symmetric key associated with the given ID. ## Returns the symmetric key associated with the given ID.
## ##
## id: Identifier of key. ## id: Identifier of key.
@ -180,7 +180,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
# Note: key not found exception as error in case not existing # Note: key not found exception as error in case not existing
result = keys.symkeys[id.string] result = keys.symkeys[id.string]
rpcsrv.rpc("shh_deleteSymKey") do(id: Identifier) -> bool: rpcsrv.rpc("waku_deleteSymKey") do(id: Identifier) -> bool:
## Deletes the key associated with the name string if it exists. ## Deletes the key associated with the name string if it exists.
## ##
## id: Identifier of key. ## id: Identifier of key.
@ -191,7 +191,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
if not result: if not result:
raise newException(ValueError, "Invalid key id") raise newException(ValueError, "Invalid key id")
rpcsrv.rpc("shh_subscribe") do(id: string, rpcsrv.rpc("waku_subscribe") do(id: string,
options: WhisperFilterOptions) -> Identifier: options: WhisperFilterOptions) -> Identifier:
## Creates and registers a new subscription to receive notifications for ## Creates and registers a new subscription to receive notifications for
## inbound whisper messages. Returns the ID of the newly created ## inbound whisper messages. Returns the ID of the newly created
@ -206,7 +206,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
# TODO: implement subscriptions, only for WS & IPC? # TODO: implement subscriptions, only for WS & IPC?
discard discard
rpcsrv.rpc("shh_unsubscribe") do(id: Identifier) -> bool: rpcsrv.rpc("waku_unsubscribe") do(id: Identifier) -> bool:
## Cancels and removes an existing subscription. ## Cancels and removes an existing subscription.
## ##
## id: Subscription identifier ## id: Subscription identifier
@ -223,7 +223,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
if asym.isNone() and topic.isNone(): if asym.isNone() and topic.isNone():
raise newException(ValueError, "Topic mandatory with symmetric key") raise newException(ValueError, "Topic mandatory with symmetric key")
rpcsrv.rpc("shh_newMessageFilter") do(options: WhisperFilterOptions) -> Identifier: rpcsrv.rpc("waku_newMessageFilter") do(options: WhisperFilterOptions) -> Identifier:
## Create a new filter within the node. This filter can be used to poll for ## Create a new filter within the node. This filter can be used to poll for
## new messages that match the set of criteria. ## new messages that match the set of criteria.
## ##
@ -283,7 +283,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
except CatchableError: except CatchableError:
trace "setBloomFilter error occured" trace "setBloomFilter error occured"
rpcsrv.rpc("shh_deleteMessageFilter") do(id: Identifier) -> bool: rpcsrv.rpc("waku_deleteMessageFilter") do(id: Identifier) -> bool:
## Uninstall a message filter in the node. ## Uninstall a message filter in the node.
## ##
## id: Filter identifier as returned when the filter was created. ## id: Filter identifier as returned when the filter was created.
@ -293,11 +293,11 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
if not result: if not result:
raise newException(ValueError, "Invalid filter id") raise newException(ValueError, "Invalid filter id")
rpcsrv.rpc("shh_getFilterMessages") do(id: Identifier) -> seq[WhisperFilterMessage]: rpcsrv.rpc("waku_getFilterMessages") do(id: Identifier) -> seq[WhisperFilterMessage]:
## Retrieve messages that match the filter criteria and are received between ## Retrieve messages that match the filter criteria and are received between
## the last time this function was called and now. ## the last time this function was called and now.
## ##
## id: ID of filter that was created with `shh_newMessageFilter`. ## id: ID of filter that was created with `waku_newMessageFilter`.
## ##
## Returns array of messages on success and an error on failure. ## Returns array of messages on success and an error on failure.
let messages = node.getFilterMessages(id.string) let messages = node.getFilterMessages(id.string)
@ -319,7 +319,7 @@ proc setupWakuRPC*(node: EthereumNode, keys: KeyStorage, rpcsrv: RpcServer) =
result.add(filterMsg) result.add(filterMsg)
rpcsrv.rpc("shh_post") do(message: WhisperPostMessage) -> bool: rpcsrv.rpc("waku_post") do(message: WhisperPostMessage) -> bool:
## Creates a whisper message and injects it into the network for ## Creates a whisper message and injects it into the network for
## distribution. ## distribution.
## ##

17
waku/quicksim.nim
View File

@ -8,9 +8,6 @@ from os import DirSep
from strutils import rsplit from strutils import rsplit
template sourceDir: string = currentSourcePath.rsplit(DirSep, 1)[0] template sourceDir: string = currentSourcePath.rsplit(DirSep, 1)[0]
# TODO: move this to rpc folder? Or just directly to nim-web3 and import that?
const sigEthPath = &"{sourceDir}{DirSep}..{DirSep}tests{DirSep}rpcclient{DirSep}ethcallsigs.nim"
createRpcSigs(RpcHttpClient, sigEthPath)
const sigWakuPath = &"{sourceDir}{DirSep}rpc{DirSep}wakucallsigs.nim" const sigWakuPath = &"{sourceDir}{DirSep}rpc{DirSep}wakucallsigs.nim"
createRpcSigs(RpcHttpClient, sigWakuPath) createRpcSigs(RpcHttpClient, sigWakuPath)
@ -33,17 +30,17 @@ proc generateTopics(amount = 100): seq[waku_protocol.Topic] =
let let
symKey = "0x0000000000000000000000000000000000000000000000000000000000000001" symKey = "0x0000000000000000000000000000000000000000000000000000000000000001"
topics = generateTopics() topics = generateTopics()
symKeyID = waitFor lightWakuNode.shh_addSymKey(symKey) symKeyID = waitFor lightWakuNode.waku_addSymKey(symKey)
options = WhisperFilterOptions(symKeyID: some(symKeyID), options = WhisperFilterOptions(symKeyID: some(symKeyID),
topics: some(topics)) topics: some(topics))
filterID = waitFor lightWakuNode.shh_newMessageFilter(options) filterID = waitFor lightWakuNode.waku_newMessageFilter(options)
symKeyID2 = waitFor lightNode.shh_addSymKey(symKey) symKeyID2 = waitFor lightNode.waku_addSymKey(symKey)
options2 = WhisperFilterOptions(symKeyID: some(symKeyID2), options2 = WhisperFilterOptions(symKeyID: some(symKeyID2),
topics: some(topics)) topics: some(topics))
filterID2 = waitFor lightNode.shh_newMessageFilter(options2) filterID2 = waitFor lightNode.waku_newMessageFilter(options2)
symkeyID3 = waitFor trafficNode.shh_addSymKey(symKey) symkeyID3 = waitFor trafficNode.waku_addSymKey(symKey)
var message = WhisperPostMessage(symKeyID: some(symkeyID3), var message = WhisperPostMessage(symKeyID: some(symkeyID3),
ttl: 30, ttl: 30,
@ -51,13 +48,13 @@ var message = WhisperPostMessage(symKeyID: some(symkeyID3),
payload: "0x45879632".HexDataStr, payload: "0x45879632".HexDataStr,
powTime: 1.0, powTime: 1.0,
powTarget: 0.002) powTarget: 0.002)
discard waitFor trafficNode.shh_post(message) discard waitFor trafficNode.waku_post(message)
var messages: seq[WhisperFilterMessage] var messages: seq[WhisperFilterMessage]
# Check if the subscription for the topic works # Check if the subscription for the topic works
while messages.len == 0: while messages.len == 0:
messages = waitFor lightWakuNode.shh_getFilterMessages(filterID) messages = waitFor lightWakuNode.waku_getFilterMessages(filterID)
waitFor sleepAsync(1000.milliseconds) waitFor sleepAsync(1000.milliseconds)
info "Received test message", payload = messages[0].payload info "Received test message", payload = messages[0].payload

25
waku/rpc/wakucallsigs.nim
View File

@ -1,2 +1,27 @@
proc waku_version(): string
proc waku_info(): WhisperInfo
proc waku_setMaxMessageSize(size: uint64): bool
proc waku_setMinPoW(pow: float): bool
proc waku_markTrustedPeer(enode: string): bool
proc waku_newKeyPair(): Identifier
proc waku_addPrivateKey(key: string): Identifier
proc waku_deleteKeyPair(id: Identifier): bool
proc waku_hasKeyPair(id: Identifier): bool
proc waku_getPublicKey(id: Identifier): PublicKey
proc waku_getPrivateKey(id: Identifier): PrivateKey
proc waku_newSymKey(): Identifier
proc waku_addSymKey(key: string): Identifier
proc waku_generateSymKeyFromPassword(password: string): Identifier
proc waku_hasSymKey(id: Identifier): bool
proc waku_getSymKey(id: Identifier): SymKey
proc waku_deleteSymKey(id: Identifier): bool
proc waku_newMessageFilter(options: WhisperFilterOptions): Identifier
proc waku_deleteMessageFilter(id: Identifier): bool
proc waku_getFilterMessages(id: Identifier): seq[WhisperFilterMessage]
proc waku_post(message: WhisperPostMessage): bool
proc wakusim_generateTraffic(amount: int): bool proc wakusim_generateTraffic(amount: int): bool
proc wakusim_generateRandomTraffic(amount: int): bool proc wakusim_generateRandomTraffic(amount: int): bool