mirror of
https://github.com/codex-storage/nim-codex.git
synced 2025-01-09 20:45:38 +00:00
de88fd2c53
* implement a logging proxy The logging proxy: - prevents the need to import chronicles (as well as export except toJson), - prevents the need to override `writeValue` or use or import nim-json-seralization elsewhere in the codebase, allowing for sole use of utils/json for de/serialization, - and handles json formatting correctly in chronicles json sinks * Rename logging -> logutils to avoid ambiguity with common names * clean up * add setProperty for JsonRecord, remove nim-json-serialization conflict * Allow specifying textlines and json format separately Not specifying a LogFormat will apply the formatting to both textlines and json sinks. Specifying a LogFormat will apply the formatting to only that sink. * remove unneeded usages of std/json We only need to import utils/json instead of std/json * move serialization from rest/json to utils/json so it can be shared * fix NoColors ambiguity Was causing unit tests to fail on Windows. * Remove nre usage to fix Windows error Windows was erroring with `could not load: pcre64.dll`. Instead of fixing that error, remove the pcre usage :) * Add logutils module doc * Shorten logutils.formatIt for `NBytes` Both json and textlines formatIt were not needed, and could be combined into one formatIt * remove debug integration test config debug output and logformat of json for integration test logs * Use ## module doc to support docgen * bump nim-poseidon2 to export fromBytes Before the changes in this branch, fromBytes was likely being resolved by nim-stew, or other dependency. With the changes in this branch, that dependency was removed and fromBytes could no longer be resolved. By exporting fromBytes from nim-poseidon, the correct resolution is now happening. * fixes to get compiling after rebasing master * Add support for Result types being logged using formatIt
144 lines
3.4 KiB
Nim
144 lines
3.4 KiB
Nim
## Nim-Codex
|
|
## Copyright (c) 2021 Status Research & Development GmbH
|
|
## Licensed under either of
|
|
## * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE))
|
|
## * MIT license ([LICENSE-MIT](LICENSE-MIT))
|
|
## at your option.
|
|
## This file may not be copied, modified, or distributed except according to
|
|
## those terms.
|
|
|
|
import std/tables
|
|
import std/sugar
|
|
|
|
export tables
|
|
|
|
import pkg/upraises
|
|
|
|
push: {.upraises: [].}
|
|
|
|
import pkg/libp2p/[cid, multicodec, multihash]
|
|
import pkg/stew/byteutils
|
|
import pkg/questionable
|
|
import pkg/questionable/results
|
|
|
|
import ./units
|
|
import ./utils
|
|
import ./errors
|
|
import ./logutils
|
|
import ./utils/json
|
|
import ./codextypes
|
|
|
|
export errors, logutils, units, codextypes
|
|
|
|
type
|
|
Block* = ref object of RootObj
|
|
cid*: Cid
|
|
data*: seq[byte]
|
|
|
|
BlockAddress* = object
|
|
case leaf*: bool
|
|
of true:
|
|
treeCid* {.serialize.}: Cid
|
|
index* {.serialize.}: Natural
|
|
else:
|
|
cid* {.serialize.}: Cid
|
|
|
|
logutils.formatIt(LogFormat.textLines, BlockAddress):
|
|
if it.leaf:
|
|
"treeCid: " & shortLog($it.treeCid) & ", index: " & $it.index
|
|
else:
|
|
"cid: " & shortLog($it.cid)
|
|
|
|
logutils.formatIt(LogFormat.json, BlockAddress): %it
|
|
|
|
proc `==`*(a, b: BlockAddress): bool =
|
|
a.leaf == b.leaf and
|
|
(
|
|
if a.leaf:
|
|
a.treeCid == b.treeCid and a.index == b.index
|
|
else:
|
|
a.cid == b.cid
|
|
)
|
|
|
|
proc `$`*(a: BlockAddress): string =
|
|
if a.leaf:
|
|
"treeCid: " & $a.treeCid & ", index: " & $a.index
|
|
else:
|
|
"cid: " & $a.cid
|
|
|
|
proc cidOrTreeCid*(a: BlockAddress): Cid =
|
|
if a.leaf:
|
|
a.treeCid
|
|
else:
|
|
a.cid
|
|
|
|
proc address*(b: Block): BlockAddress =
|
|
BlockAddress(leaf: false, cid: b.cid)
|
|
|
|
proc init*(_: type BlockAddress, cid: Cid): BlockAddress =
|
|
BlockAddress(leaf: false, cid: cid)
|
|
|
|
proc init*(_: type BlockAddress, treeCid: Cid, index: Natural): BlockAddress =
|
|
BlockAddress(leaf: true, treeCid: treeCid, index: index)
|
|
|
|
proc `$`*(b: Block): string =
|
|
result &= "cid: " & $b.cid
|
|
result &= "\ndata: " & string.fromBytes(b.data)
|
|
|
|
func new*(
|
|
T: type Block,
|
|
data: openArray[byte] = [],
|
|
version = CIDv1,
|
|
mcodec = Sha256HashCodec,
|
|
codec = BlockCodec
|
|
): ?!Block =
|
|
## creates a new block for both storage and network IO
|
|
##
|
|
|
|
let
|
|
hash = ? MultiHash.digest($mcodec, data).mapFailure
|
|
cid = ? Cid.init(version, codec, hash).mapFailure
|
|
|
|
# TODO: If the hash is `>=` to the data,
|
|
# use the Cid as a container!
|
|
Block(
|
|
cid: cid,
|
|
data: @data).success
|
|
|
|
proc new*(
|
|
T: type Block,
|
|
cid: Cid,
|
|
data: openArray[byte],
|
|
verify: bool = true
|
|
): ?!Block =
|
|
## creates a new block for both storage and network IO
|
|
##
|
|
|
|
if verify:
|
|
let
|
|
mhash = ? cid.mhash.mapFailure
|
|
computedMhash = ? MultiHash.digest($mhash.mcodec, data).mapFailure
|
|
computedCid = ? Cid.init(cid.cidver, cid.mcodec, computedMhash).mapFailure
|
|
if computedCid != cid:
|
|
return "Cid doesn't match the data".failure
|
|
|
|
return Block(
|
|
cid: cid,
|
|
data: @data
|
|
).success
|
|
|
|
proc emptyBlock*(version: CidVersion, hcodec: MultiCodec): ?!Block =
|
|
emptyCid(version, hcodec, BlockCodec)
|
|
.flatMap((cid: Cid) => Block.new(cid = cid, data = @[]))
|
|
|
|
proc emptyBlock*(cid: Cid): ?!Block =
|
|
cid.mhash.mapFailure.flatMap((mhash: MultiHash) =>
|
|
emptyBlock(cid.cidver, mhash.mcodec))
|
|
|
|
proc isEmpty*(cid: Cid): bool =
|
|
success(cid) == cid.mhash.mapFailure.flatMap((mhash: MultiHash) =>
|
|
emptyCid(cid.cidver, mhash.mcodec, cid.mcodec))
|
|
|
|
proc isEmpty*(blk: Block): bool =
|
|
blk.cid.isEmpty
|