Merge pull request #22 from status-im/feat/util-functions

feat: some utils functions and nim-test template

.gitmodules

@@ -4,3 +4,27 @@
 [submodule "vendor/status-go"]
 	path = vendor/status-go
 	url = https://github.com/status-im/status-go
+[submodule "vendor/nimcrypto"]
+	path = vendor/nimcrypto
+	url = https://github.com/cheatfate/nimcrypto
+[submodule "vendor/nim-chronicles"]
+	path = vendor/nim-chronicles
+	url = https://github.com/status-im/nim-chronicles
+[submodule "vendor/nim-faststreams"]
+	path = vendor/nim-faststreams
+	url = https://github.com/status-im/nim-faststreams
+[submodule "vendor/nim-stint"]
+	path = vendor/nim-stint
+	url = https://github.com/status-im/nim-stint
+[submodule "vendor/nim-serialization"]
+	path = vendor/nim-serialization
+	url = https://github.com/status-im/nim-serialization
+[submodule "vendor/nim-chronos"]
+	path = vendor/nim-chronos
+	url = https://github.com/status-im/nim-chronos
+[submodule "vendor/nim-stew"]
+	path = vendor/nim-stew
+	url = https://github.com/status-im/nim-stew
+[submodule "vendor/nim-json-serialization"]
+	path = vendor/nim-json-serialization
+	url = https://github.com/status-im/nim-json-serialization/

Makefile

@@ -111,9 +111,9 @@ $(STATUSGO): | deps
 
 clean: | clean-common clean-build-dir
 	rm -rf $(STATUSGO)
-	rm keystore
+	rm -rf keystore
-	rm data
+	rm -rf data
-	rm noBackup
+	rm -rf noBackup
 
 clean-build-dir:
 	rm -rf build/*

nim.cfg

@@ -1,3 +1,3 @@
 # we need to link C++ libraries
 gcc.linkerexe="g++"
-
+ --threads:on

src/nim_status.nim

@@ -4,6 +4,8 @@ import types
 # All procs start with lowercase because the compiler will also need to import status-go,
 # and it will complain of duplication of function names
 
+export SignalCallback
+
 proc hashMessage*(message: cstring): cstring {.exportc.} =
   setupForeignThreadGc()
   result = status_go.HashMessage(message)

tests/test1.nim

@@ -1,6 +1,40 @@
 {.passL:"vendor/status-go/build/bin/libstatus.a"}
+when defined(macosx):
+  {.passl: "-framework Foundation".}
+  {.passl: "-framework Security".}
+  {.passl: "-framework IOKit".}
+  {.passl: "-framework CoreServices".}
 
 import ../src/nim_status
+import utils
+import chronicles
+import os
+
+var onSignal: SignalCallback = proc(message: cstring) {.cdecl.} = 
+  setupForeignThreadGC()
+  echo message
+  tearDownForeignThreadGc()
+setSignalEventCallback(onSignal)
+
+resetDirectories() # Recreates the data and nobackup dir
+
+init()
+
+# Call either createAccountAndLogin("somePassword") to create a new random account
+# or restoreAccountAndLogin("cattle act enable unable own music material canvas either shoe must junior", "somePassword")
+# if no password is specified, it will use "qwerty"
+
+let publicKey = createAccountAndLogin("somePassword")
+
+
+# There's a login("somePassword") function that will login the first account. It assumes the directories have been already set.
+
+
+# TODO: wait for a {"type":"node.login" signal to know that you have already logged in. These signals are available in onSignal ^
+while true:
+
+  echo "..."
+  sleep(1000)
+
+
 
-echo "Executing test 1"
-assert hashMessage("qwerty") == """{"result":"0xfeeeea836fc42840b42a5af9bdcdab1d0e3a9b5168bf46fa25c3704c810eadbe"}"""

tests/utils.nim

@@ -0,0 +1,281 @@
+import json
+import ../src/nim_status
+import nimcrypto
+import chronicles
+import os
+
+proc hashPassword(password: string): string =
+  result = "0x" & $keccak_256.digest(password)
+
+proc resetDirectories*()=
+  debug "Reset directories"
+  removeDir("./data")
+  createDir("./data")
+  removeDir("./noBackup")
+  createDir("./noBackup")
+
+proc init*() =
+  debug "Initializing keystore"
+  assert initKeystore("./data") == """{"error":""}"""
+  assert openAccounts("./noBackup") != """{"error":"unable to open database file"}""";
+
+proc AndLogin(account0: JsonNode, pwd: string) =
+  let password = hashPassword(pwd)
+  
+  let multiAccounts = parseJson($multiAccountStoreDerivedAccounts($ %* {
+    "accountID": account0["id"].getStr,
+    "paths": ["m/44'/60'/0'/0", "m/43'/60'/1581'", "m/43'/60'/1581'/0'/0", "m/44'/60'/0'/0/0"],
+    "password": password
+  }))
+
+  let accountData = %* {
+    "name": "Delectable Overjoyed Nauplius",
+    "address": account0["address"].getStr,
+    "photo-path": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAmElEQVR4nOzX4QmAIBBA4Yp2aY52aox2ao6mqf+SoajwON73M0J4HBy6TEEYQmMIjSE0htCECVlbDziv+/n6fuzb3OP/UmEmYgiNITRNm+LPqO2UE2YihtAYQlN818ptoZzau1btOakwEzGExhCa5hdi7d2p1zZLhZmIITSG0PhCpDGExhANEmYihtAYQmMIjSE0bwAAAP//kHQdRIWYzToAAAAASUVORK5CYII=",
+    "key-uid": account0["keyUid"].getStr,
+    "keycard-pairing": nil
+  }
+
+  let settingsJSON = %* {
+    "key-uid": account0["keyUid"].getStr,
+    "mnemonic": account0["mnemonic"].getStr,
+    "public-key": multiAccounts["m/43'/60'/1581'/0'/0"]["publicKey"].getStr,
+    "name": accountData["name"].getStr,
+    "address":  account0["address"].getStr,
+    "eip1581-address": multiAccounts["m/43'/60'/1581'"]["address"].getStr,
+    "dapps-address": multiAccounts["m/44'/60'/0'/0/0"]["address"].getStr,
+    "wallet-root-address":  multiAccounts["m/44'/60'/0'/0"]["address"].getStr,
+    "preview-privacy?": true,
+    "signing-phrase": "dust gear boss",
+    "log-level": "INFO",
+    "latest-derived-path": 0,
+    "networks/networks": [
+      {
+        "id": "testnet_rpc",
+        "etherscan-link": "https://ropsten.etherscan.io/address/",
+        "name": "Ropsten with upstream RPC",
+        "config": {
+          "NetworkId": 3,
+          "DataDir": "/ethereum/testnet_rpc",
+          "UpstreamConfig": {
+            "Enabled": true,
+            "URL": "https://ropsten.infura.io/v3/f315575765b14720b32382a61a89341a",
+          },
+        },
+      },
+      {
+        "id": "rinkeby_rpc",
+        "etherscan-link": "https://rinkeby.etherscan.io/address/",
+        "name": "Rinkeby with upstream RPC",
+        "config": {
+          "NetworkId": 4,
+          "DataDir": "/ethereum/rinkeby_rpc",
+          "UpstreamConfig": {
+            "Enabled": true,
+            "URL": "https://rinkeby.infura.io/v3/f315575765b14720b32382a61a89341a",
+          },
+        },
+      },
+      {
+        "id": "goerli_rpc",
+        "etherscan-link": "https://goerli.etherscan.io/address/",
+        "name": "Goerli with upstream RPC",
+        "config": {
+          "NetworkId": 5,
+          "DataDir": "/ethereum/goerli_rpc",
+          "UpstreamConfig": {
+            "Enabled": true,
+            "URL": "https://goerli.blockscout.com/",
+          },
+        },
+      },
+      {
+        "id": "mainnet_rpc",
+        "etherscan-link": "https://etherscan.io/address/",
+        "name": "Mainnet with upstream RPC",
+        "config": {
+          "NetworkId": 1,
+          "DataDir": "/ethereum/mainnet_rpc",
+          "UpstreamConfig": {
+            "Enabled": true,
+            "URL": "https://mainnet.infura.io/v3/f315575765b14720b32382a61a89341a",
+          },
+        },
+      },
+      {
+        "id": "xdai_rpc",
+        "name": "xDai Chain",
+        "config": {
+          "NetworkId": 100,
+          "DataDir": "/ethereum/xdai_rpc",
+          "UpstreamConfig": {
+            "Enabled": true,
+            "URL": "https://dai.poa.network"
+          },
+        },
+      },
+      {
+        "id": "poa_rpc",
+        "name": "POA Network",
+        "config": {
+          "NetworkId": 99,
+          "DataDir": "/ethereum/poa_rpc",
+          "UpstreamConfig": {
+            "Enabled": true,
+            "URL": "https://core.poa.network"
+          },
+        },
+      },
+    ],
+    "currency": "usd",
+    "photo-path": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAmElEQVR4nOzX4QmAIBBA4Yp2aY52aox2ao6mqf+SoajwON73M0J4HBy6TEEYQmMIjSE0htCECVlbDziv+/n6fuzb3OP/UmEmYgiNITRNm+LPqO2UE2YihtAYQlN818ptoZzau1btOakwEzGExhCa5hdi7d2p1zZLhZmIITSG0PhCpDGExhANEmYihtAYQmMIjSE0bwAAAP//kHQdRIWYzToAAAAASUVORK5CYII=",
+    "waku-enabled": true,
+    "wallet/visible-tokens": {
+      "mainnet": ["SNT"]
+    },
+    "appearance": 0,
+    "networks/current-network": "mainnet_rpc",
+    "installation-id": "5d6bc316-a97e-5b89-9541-ad01f8eb7397",
+  }
+  
+  let configJSON = %* {
+    "BrowsersConfig": { 
+      "Enabled": true
+    },
+    "ClusterConfig": {
+      "BootNodes": [
+        "enode://23d0740b11919358625d79d4cac7d50a34d79e9c69e16831c5c70573757a1f5d7d884510bc595d7ee4da3c1508adf87bbc9e9260d804ef03f8c1e37f2fb2fc69@47.52.106.107:443",
+        "enode://5395aab7833f1ecb671b59bf0521cf20224fe8162fc3d2675de4ee4d5636a75ec32d13268fc184df8d1ddfa803943906882da62a4df42d4fccf6d17808156a87@178.128.140.188:443",
+        "enode://6e6554fb3034b211398fcd0f0082cbb6bd13619e1a7e76ba66e1809aaa0c5f1ac53c9ae79cf2fd4a7bacb10d12010899b370c75fed19b991d9c0cdd02891abad@47.75.99.169:443",
+        "enode://5405c509df683c962e7c9470b251bb679dd6978f82d5b469f1f6c64d11d50fbd5dd9f7801c6ad51f3b20a5f6c7ffe248cc9ab223f8bcbaeaf14bb1c0ef295fd0@35.223.215.156:443",
+      ],
+      "Enabled": true,
+      "Fleet": "eth.prod",
+      "RendezvousNodes": [
+        "/ip4/34.70.75.208/tcp/30703/ethv4/16Uiu2HAm6ZsERLx2BwVD2UM9SVPnnMU6NBycG8XPtu8qKys5awsU",
+        "/ip4/178.128.140.188/tcp/30703/ethv4/16Uiu2HAmLqTXuY4Sb6G28HNooaFUXUKzpzKXCcgyJxgaEE2i5vnf",
+        "/ip4/47.52.106.107/tcp/30703/ethv4/16Uiu2HAmEHiptiDDd9gqNY8oQqo8hHUWMHJzfwt5aLRdD6W2zcXR",
+      ],
+      "StaticNodes": [
+        "enode://887cbd92d95afc2c5f1e227356314a53d3d18855880ac0509e0c0870362aee03939d4074e6ad31365915af41d34320b5094bfcc12a67c381788cd7298d06c875@178.128.141.0:443",
+        "enode://fbeddac99d396b91d59f2c63a3cb5fc7e0f8a9f7ce6fe5f2eed5e787a0154161b7173a6a73124a4275ef338b8966dc70a611e9ae2192f0f2340395661fad81c0@34.67.230.193:443",
+      ],
+      "TrustedMailServers": [
+        "enode://2c8de3cbb27a3d30cbb5b3e003bc722b126f5aef82e2052aaef032ca94e0c7ad219e533ba88c70585ebd802de206693255335b100307645ab5170e88620d2a81@47.244.221.14:443",
+        "enode://ee2b53b0ace9692167a410514bca3024695dbf0e1a68e1dff9716da620efb195f04a4b9e873fb9b74ac84de801106c465b8e2b6c4f0d93b8749d1578bfcaf03e@104.197.238.144:443",
+        "enode://8a64b3c349a2e0ef4a32ea49609ed6eb3364be1110253c20adc17a3cebbc39a219e5d3e13b151c0eee5d8e0f9a8ba2cd026014e67b41a4ab7d1d5dd67ca27427@178.128.142.94:443",
+        "enode://7aa648d6e855950b2e3d3bf220c496e0cae4adfddef3e1e6062e6b177aec93bc6cdcf1282cb40d1656932ebfdd565729da440368d7c4da7dbd4d004b1ac02bf8@178.128.142.26:443",
+        "enode://c42f368a23fa98ee546fd247220759062323249ef657d26d357a777443aec04db1b29a3a22ef3e7c548e18493ddaf51a31b0aed6079bd6ebe5ae838fcfaf3a49@178.128.142.54:443",
+        "enode://30211cbd81c25f07b03a0196d56e6ce4604bb13db773ff1c0ea2253547fafd6c06eae6ad3533e2ba39d59564cfbdbb5e2ce7c137a5ebb85e99dcfc7a75f99f55@23.236.58.92:443",
+      ],
+    },
+    "DataDir": "./ethereum/mainnet", # TODO add network name
+    "EnableNTPSync": true,
+    "KeyStoreDir": "./keystore",
+    "ListenAddr": ":30304",
+    "LogEnabled": true,
+    "LogFile": "geth.log",
+    "LogLevel": "INFO",
+    "MailserversConfig": {
+      "Enabled": true
+    },
+    "Name": "StatusIM",
+    "NetworkId": 1,
+    "NoDiscovery": false,
+    "PermissionsConfig": {
+      "Enabled": true
+    },
+    "Rendezvous": true,
+    "RequireTopics": {
+      "whisper": {
+        "Max": 2,
+        "Min": 2
+      }
+    },
+    "ShhextConfig": {
+      "BackupDisabledDataDir": "./",
+      "DataSyncEnabled": true,
+      "InstallationID": "aef27732-8d86-5039-a32e-bdbe094d8791",
+      "MailServerConfirmations": true,
+      "MaxMessageDeliveryAttempts": 6,
+      "PFSEnabled": true,
+      "VerifyENSContractAddress": "0x00000000000C2E074eC69A0dFb2997BA6C7d2e1e",
+      "VerifyENSURL": "https://mainnet.infura.io/v3/f315575765b14720b32382a61a89341a",
+      "VerifyTransactionChainID": 1,
+      "VerifyTransactionURL": "https://mainnet.infura.io/v3/f315575765b14720b32382a61a89341a",
+    },
+    "StatusAccountsConfig": {
+      "Enabled": true
+    },
+    "UpstreamConfig": {
+      "Enabled": true,
+      "URL": "https://mainnet.infura.io/v3/f315575765b14720b32382a61a89341a",
+    },
+    "WakuConfig": {
+      "BloomFilterMode": nil,
+      "Enabled": true,
+      "LightClient": true,
+      "MinimumPoW": 0.001
+    },
+    "WalletConfig": {
+      "Enabled": true
+    }
+  }
+  
+  let subaccountData = %* [
+    {
+      "public-key": multiAccounts["m/44'/60'/0'/0/0"]["publicKey"],
+      "address": multiAccounts["m/44'/60'/0'/0/0"]["address"],
+      "color":"#4360df",
+      "wallet":true,
+      "path":"m/44'/60'/0'/0/0",
+      "name":"Status account"
+    },
+    {
+      "public-key": multiAccounts["m/43'/60'/1581'/0'/0"]["publicKey"],
+      "address": multiAccounts["m/43'/60'/1581'/0'/0"]["address"],
+      "name":"Delectable Overjoyed Nauplius",
+      "photo-path":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP4ixAAAAmElEQVR4nOzX4QmAIBBA4Yp2aY52aox2ao6mqf+SoajwON73M0J4HBy6TEEYQmMIjSE0htCECVlbDziv+/n6fuzb3OP/UmEmYgiNITRNm+LPqO2UE2YihtAYQlN818ptoZzau1btOakwEzGExhCa5hdi7d2p1zZLhZmIITSG0PhCpDGExhANEmYihtAYQmMIjSE0bwAAAP//kHQdRIWYzToAAAAASUVORK5CYII=",
+      "path":"m/43'/60'/1581'/0'/0",
+      "chat":true
+    }
+  ]
+ 
+  let saveResult = parseJson($saveAccountAndLogin($accountData, password, $settingsJSON, $configJSON, $subaccountData))
+  assert saveResult["error"].getStr == ""
+
+  debug "Login successful"
+
+proc createAccountAndLogin*(password: string = "qwerty"):string = 
+  debug "Creating an account"
+
+  let generatedAddresses = parseJson($multiAccountGenerateAndDeriveAddresses($ %* {
+    "n": 5,
+    "mnemonicPhraseLength": 12,
+    "bip39Passphrase": "", 
+    "paths": ["m/43'/60'/1581'/0'/0", "m/44'/60'/0'/0/0"]
+  }))
+
+  result = generatedAddresses[0]["publicKey"].getStr
+  debug "Account created", result
+  
+  AndLogin(generatedAddresses[0], password)
+
+  
+ 
+proc restoreAccountAndLogin*(mnemonic: string, password: string = "qwerty"):string =
+  let importedAddress = parseJson($ multiAccountImportMnemonic($ %* {
+    "mnemonicPhrase": mnemonic,
+    "Bip39Passphrase": ""
+  }))
+
+  result = importedAddress["publicKey"].getStr
+
+  AndLogin(importedAddress, password)
+
+proc logoutAccount*() =
+  discard logout()
+
+proc login*(password: string) =
+  let account = $parseJson($openAccounts("./noBackup"))[0]
+  assert login(account, hashPassword(password)) == """{"error":""}"""

vendor/nim-chronicles

@@ -0,0 +1 @@
+Subproject commit 3e42e9a33e3e490d9f18d8e33219f67f64f4d8a7

vendor/nim-chronos

@@ -0,0 +1 @@
+Subproject commit 63041b2d8f54a4873a78b93421046038fb5e01d3

vendor/nim-faststreams

@@ -0,0 +1 @@
+Subproject commit 5df69fc6961e58205189cd92ae2477769fa8c4c0

vendor/nim-json-serialization

@@ -0,0 +1 @@
+Subproject commit 1cf51931f1037a2c44fa0912386273c01a0e0e42

vendor/nim-serialization

@@ -0,0 +1 @@
+Subproject commit 5b11c4173159a15d52f0bb6a26a1aa2b40f0f2be

vendor/nim-stew

@@ -0,0 +1 @@
+Subproject commit ec2f52b0cea1f1daa33f38ca4ba289d8f40f4104

vendor/nim-stint

@@ -0,0 +1 @@
+Subproject commit 9e49b00148884a01d61478ae5d2c69b543b93ceb

vendor/nimcrypto

@@ -0,0 +1 @@
+Subproject commit f767595f4ddec2b5570b5194feb96954c00a6499