feat: Network accessors

Signed-off-by: Anirudh <[email protected]>
graphprotocol · Mar 14, 2023 · ca38e6a · ca38e6a
1 parent e416bfe
commit ca38e6a
Show file tree

Hide file tree

Showing 2 changed files with 129 additions and 0 deletions.
diff --git a/src/domain.jl b/src/domain.jl
@@ -19,6 +19,117 @@ julia> AllocationOpt.togrt("1")
 """
 togrt(x::AbstractString) = parse(Float64, x) / ethtogrt
 
+
+"""
+    totalsupply(::Val{:network}, x)
+
+The total GRT supply.
+
+```julia
+julia> using AllocationOpt
+julia> using TheGraphData
+julia> n = flextable([
+    Dict(
+        "id" => 1,
+        "totalSupply" => 1,
+        "networkGRTIssuance" => 1,
+        "epochLength" => 28,
+        "totalTokensSignalled" => 2,
+        "currentEpoch" => 1,
+    )
+])
+julia> AllocationOpt.totalsupply(Val(:network), n)
+"""
+totalsupply(::Val{:network}, x) = x.totalSupply |> only
+
+"""
+    blockissuance(::Val{:network}, x)
+
+The tokens issued per block.
+
+```julia
+julia> using AllocationOpt
+julia> using TheGraphData
+julia> n = flextable([
+    Dict(
+        "id" => 1,
+        "totalSupply" => 1,
+        "networkGRTIssuance" => 1,
+        "epochLength" => 28,
+        "totalTokensSignalled" => 2,
+        "currentEpoch" => 1,
+    )
+])
+julia> AllocationOpt.blockissuance(Val(:network), n)
+"""
+blockissuance(::Val{:network}, x) = x.networkGRTIssuance |> only
+
+"""
+    blocksperepoch(::Val{:network}, x)
+
+The number of blocks in each epoch.
+
+```julia
+julia> using AllocationOpt
+julia> using TheGraphData
+julia> n = flextable([
+    Dict(
+        "id" => 1,
+        "totalSupply" => 1,
+        "networkGRTIssuance" => 1,
+        "epochLength" => 28,
+        "totalTokensSignalled" => 2,
+        "currentEpoch" => 1,
+    )
+])
+julia> AllocationOpt.blocksperepoch(Val(:network), n)
+"""
+blocksperepoch(::Val{:network}, x) = x.epochLength |> only
+
+"""
+    totalsignal(::Val{:network}, x)
+
+The total signal in the network
+
+```julia
+julia> using AllocationOpt
+julia> using TheGraphData
+julia> n = flextable([
+    Dict(
+        "id" => 1,
+        "totalSupply" => 1,
+        "networkGRTIssuance" => 1,
+        "epochLength" => 28,
+        "totalTokensSignalled" => 2,
+        "currentEpoch" => 1,
+    )
+])
+julia> AllocationOpt.totalsignal(Val(:network), n)
+"""
+totalsignal(::Val{:network}, x) = x.totalTokensSignalled |> only
+
+"""
+    currentepoch(::Val{:network}, x)
+
+The current epoch.
+
+```julia
+julia> using AllocationOpt
+julia> using TheGraphData
+julia> n = flextable([
+    Dict(
+        "id" => 1,
+        "totalSupply" => 1,
+        "networkGRTIssuance" => 1,
+        "epochLength" => 28,
+        "totalTokensSignalled" => 2,
+        "currentEpoch" => 1,
+    )
+])
+julia> AllocationOpt.currentepoch.(Val(:network), n)
+"""
+currentepoch(::Val{:network}, x) = x.currentEpoch |> only
+
 """
     ipfshash(::Val{:allocation}, x)
 

diff --git a/test/domain.jl b/test/domain.jl
@@ -8,6 +8,24 @@
 
     @testset "accessors" begin
 
+        @testset "network" begin
+            n = flextable([
+                Dict(
+                    "id" => 1,
+                    "totalSupply" => 1,
+                    "networkGRTIssuance" => 1,
+                    "epochLength" => 28,
+                    "totalTokensSignalled" => 2,
+                    "currentEpoch" => 1,
+                )
+            ])
+            @test AllocationOpt.totalsupply(Val(:network), n) == 1
+            @test AllocationOpt.blockissuance(Val(:network), n) == 1
+            @test AllocationOpt.blocksperepoch(Val(:network), n) == 28
+            @test AllocationOpt.totalsignal(Val(:network), n) == 2
+            @test AllocationOpt.currentepoch(Val(:network), n) == 1
+        end
+
         @testset "allocation" begin
             x = flextable([
                 Dict("allocatedTokens" => 1, "subgraphDeployment.ipfsHash" => "Qma")