add account storage keys support to multikeys

stateless/multi_keys.nim

@@ -4,25 +4,32 @@ import
 
 type
   KeyHash = array[32, byte]
+  StorageSlot = array[32, byte]
 
-  HashAddress = object
+  KeyData = object
     visited: bool
     hash: KeyHash
+    case storageMode: bool
+    of true:
+      storageSlot: StorageSlot
+    of false:
+      storageKeys: MultikeysRef
       address: EthAddress
 
   Multikeys* = object
-    keys: seq[HashAddress]
+    keys: seq[KeyData]
+
+  MultikeysRef* = ref Multikeys
 
   Group* = object
-    a, b: int16
+    first, last: int16
 
   BranchGroup* = object
     mask*: uint
     groups*: array[16, Group]
 
-  GroupNibble = object
+  AccountKey* = tuple[address: EthAddress, storageKeys: MultikeysRef]
-    nibble: byte
+  MatchGroup* = tuple[match: bool, group: Group]
-    group: Group
 
 func cmpHash(a, b: KeyHash): int =
   var i = 0
@@ -33,44 +40,15 @@ func cmpHash(a, b: KeyHash): int =
     inc(i)
   result = a.len - b.len
 
-func cmpHash(a, b: HashAddress): int =
+func cmpHash(a, b: KeyData): int =
   cmpHash(a.hash, b.hash)
 
-proc initMultiKeys*(addrs: openArray[EthAddress]): Multikeys =
-  result.keys = newSeq[HashAddress](addrs.len)
-  for i, a in addrs:
-    result.keys[i] = HashAddress(hash: keccak(a).data, address: a)
-  result.keys.sort(cmpHash)
-
-func `$`(x: KeyHash): string =
-  toHex(x)
-
-func initGroup*(m: Multikeys): Group =
-  result = Group(a: 0'i16, b: (m.keys.len - 1).int16)
-
-func initChildGroup(a: Group): Group =
-  result = Group(a: a.a-1'i16, b: a.a-1'i16)
-
 func getNibble(x: openArray[byte], i: int): byte =
   if(i and 0x01) == 0x01:
     result = x[i shr 1] and 0x0F
   else:
     result = x[i shr 1] shr 4
 
-func nextGroup(m: Multikeys, depth: int, g: Group): GroupNibble =
-  result.group.a = g.b + 1
-  result.nibble = getNibble(m.keys[result.group.a].hash, depth)
-  let last = (m.keys.len - 1).int16
-  for i in result.group.a..<m.keys.len.int16:
-    if getNibble(m.keys[i].hash, depth) != result.nibble:
-      result.group.b = i - 1
-      break
-    elif i == last:
-      result.group.b = last
-
-func lastGroup(a: Group, g: Group): bool =
-  a.b == g.b
-
 func compareNibbles(x: openArray[byte], start: int, n: NibblesSeq): bool =
   var i = 0
   while i < n.len:
@@ -79,73 +57,107 @@ func compareNibbles(x: openArray[byte], start: int, n: NibblesSeq): bool =
     inc i
   result = true
 
-func groups*(m: Multikeys, parentGroup: Group, depth: int): BranchGroup =
+func `$`(x: KeyHash): string =
+  toHex(x)
+
+proc newMultiKeys*(keys: openArray[AccountKey]): MultikeysRef =
+  result = new Multikeys
+  result.keys = newSeq[KeyData](keys.len)
+  for i, a in keys:
+    result.keys[i] = KeyData(
+      storageMode: false,
+      hash: keccak(a.address).data,
+      address: a.address,
+      storageKeys: a.storageKeys)
+  result.keys.sort(cmpHash)
+
+proc newMultiKeys*(keys: openArray[StorageSlot]): MultikeysRef =
+  result = new Multikeys
+  result.keys = newSeq[KeyData](keys.len)
+  for i, a in keys:
+    result.keys[i] = KeyData(storageMode: true, hash: keccak(a).data, storageSlot: a)
+  result.keys.sort(cmpHash)
+
+func initGroup*(m: MultikeysRef): Group =
+  result = Group(first: 0'i16, last: (m.keys.len - 1).int16)
+
+func groups*(m: MultikeysRef, parentGroup: Group, depth: int): BranchGroup =
   # similar to a branch node, the product of this func
   # is a 16 bits bitmask and an array of max 16 groups
   # if the bit is set, the n-th elem of array have a group
   # each group consist of at least one key
-  var gn = GroupNibble(group: parentGroup.initChildGroup())
+  var g = Group(first: parentGroup.first, last: parentGroup.first)
-  while not parentGroup.lastGroup(gn.group):
+  var nibble = getNibble(m.keys[g.first].hash, depth)
-    gn = m.nextGroup(depth, gn.group)
+  let last = parentGroup.last
-    setBranchMaskBit(result.mask, gn.nibble.int)
+  for i in parentGroup.first..parentGroup.last:
-    result.groups[gn.nibble.int] = gn.group
+    let currNibble = getNibble(m.keys[i].hash, depth)
+    if currNibble != nibble:
+      g.last = i - 1
+      setBranchMaskBit(result.mask, nibble.int)
+      result.groups[nibble.int] = g
+      nibble = currNibble
+      g.first = i
+    if i == last:
+      g.last = last
+      setBranchMaskBit(result.mask, nibble.int)
+      result.groups[nibble.int] = g
 
-iterator groups*(m: Multikeys, depth: int, n: NibblesSeq, parentGroup: Group): (bool, Group) =
+iterator groups*(m: MultikeysRef, depth: int, n: NibblesSeq, parentGroup: Group): MatchGroup =
   # using common-prefix comparison, this iterator
   # will produce groups, usually only one match group
   # the rest will be not match
   # in case of wrong path, there will be no match at all
-  var g = Group(a: parentGroup.a, b: parentGroup.a)
+  var g = Group(first: parentGroup.first, last: parentGroup.first)
-  var match = compareNibbles(m.keys[g.a].hash, depth, n)
+  var match = compareNibbles(m.keys[g.first].hash, depth, n)
-  let last = parentGroup.b
+  let last = parentGroup.last
-  var haveMatch = false
+  var haveGroup = false
-  var matchG: Group
+  var groupResult: Group
-  var matchB: bool
+  var matchResult: bool
-  for i in parentGroup.a..parentGroup.b:
+  for i in parentGroup.first..parentGroup.last:
-    if compareNibbles(m.keys[i].hash, depth, n) == match:
+    if compareNibbles(m.keys[i].hash, depth, n) != match:
-      inc g.b
+      g.last = i - 1
-    else:
+      haveGroup = true
-      haveMatch = true
+      matchResult = match
-      matchB = match
+      groupResult = g
-      matchG = g
       match = not match
-      g = Group(a: g.b, b: g.b)
+      g = Group(first: g.last, last: g.last)
     if i == last:
-      haveMatch = true
+      haveGroup = true
-      g.b = last
+      g.last = last
-      matchG = g
+      groupResult = g
-      matchB = match
+      matchResult = match
-    if haveMatch:
+    if haveGroup:
-      haveMatch = false
+      haveGroup = false
-      yield (matchB, matchG)
+      yield (matchResult, groupResult)
 
+when isMainModule:
   let keys = [
-  hexToByteArray[20]("abcdef0a0b0c0d0e0f1234567890aabbccddeeff"),
+    (hexToByteArray[20]("abcdef0a0b0c0d0e0f1234567890aabbccddeeff"), MultikeysRef(nil)),
-  hexToByteArray[20]("abc0000000000000000000000000000000000000"),
+    (hexToByteArray[20]("abc0000000000000000000000000000000000000"), MultikeysRef(nil)),
-  hexToByteArray[20]("cde9769bbcbdef9880932852388bdceabcdeadea"),
+    (hexToByteArray[20]("cde9769bbcbdef9880932852388bdceabcdeadea"), MultikeysRef(nil)),
-  hexToByteArray[20]("bad03eaeaea69072375281381267397182bcdbef"),
+    (hexToByteArray[20]("bad03eaeaea69072375281381267397182bcdbef"), MultikeysRef(nil)),
-  hexToByteArray[20]("abcdefbbbbbbdddeefffaaccee19826736134298"),
+    (hexToByteArray[20]("abcdefbbbbbbdddeefffaaccee19826736134298"), MultikeysRef(nil)),
-  hexToByteArray[20]("ba88888888dddddbbbbfffeeeccaa78128301389"),
+    (hexToByteArray[20]("ba88888888dddddbbbbfffeeeccaa78128301389"), MultikeysRef(nil)),
-  hexToByteArray[20]("ba9084097472374372327238bbbcdffecadfecf3")
+    (hexToByteArray[20]("ba9084097472374372327238bbbcdffecadfecf3"), MultikeysRef(nil))
   ]
 
   proc main() =
-  var m = initMultikeys(keys)
+    var m = newMultikeys(keys)
 
     for x in m.keys:
       echo x.hash
 
     var parentGroup = m.initGroup()
-  var depth = 1
+    var depth = 3
     var bg = m.groups(parentGroup, depth)
 
     for i in 0..<16:
       if branchMaskBitIsSet(bg.mask, i):
         echo bg.groups[i]
 
-  var p = Group(a: 0, b: 2)
+    var p = Group(first: 0, last: 2)
-  var n = hexToByteArray[2]("cdef")
+    var n = hexToByteArray[1]("1F")
-  for j in groups(m, 2, initNibbleRange(n), p):
+    for j in groups(m, 3, initNibbleRange(n), p):
       debugEcho j
 
   main()