Merge pull request #309 from permaweb/dev/milestone-3-beta-1

HyperBEAM Milestone 3 BETA-1.

Author: samcamwilliams

.githooks/_/install.sh

@@ -1,3 +1,4 @@
+config.*
 .rebar3
 _build
 _checkouts

.githooks/commit-msg

@@ -14,7 +14,7 @@
       "internalConsoleOptions": "openOnSessionStart",
       "module": "hb_debugger",
       "function": "start_and_break",
-      "args": "[${input:moduleName}, ${input:functionName}, [${input:funcArgs}]]"
+      "args": "[${input:moduleName}, ${input:functionName}, [${input:funcArgs}], <<\"${input:debuggerScope}\">>]"
     },
     {
       "name": "Attach to a 'rebar3 debugger' node.",
@@ -65,6 +65,11 @@
       "id": "funcArgs",
       "type": "promptString",
       "description": "(Optional) Pass arguments to the function:"
+    },
+    {
+      "id": "debuggerScope",
+      "type": "promptString",
+      "description": "(Optional) Additional modules/prefixes for debugger scope:"
     }
   ]
 }

.gitignore

@@ -2,6 +2,8 @@
 {plugins, [pc, rebar3_rustler, rebar_edown_plugin]}.
 
 {profiles, [
+    {no_events, [{erl_opts, [{d, 'NO_EVENTS', true}]}]},
+    {store_events, [{erl_opts, [{d, 'STORE_EVENTS', true}]}]},
     {genesis_wasm, [
         {erl_opts, [{d, 'ENABLE_GENESIS_WASM', true}]},
         {pre_hooks, [
@@ -58,7 +60,8 @@
     { compile, "rm -f native/hb_beamr/*.o native/hb_beamr/*.d"},
     { compile, "rm -f native/hb_keccak/*.o native/hb_keccak/*.d"},
     { compile, "mkdir -p priv/html"},
-    { compile, "cp -R src/html/* priv/html"}
+    { compile, "cp -R src/html/* priv/html"},
+    { compile, "cp _build/default/lib/elmdb/priv/* priv/ 2>/dev/null || true" }
 ]}.
 
 {provider_hooks, [
@@ -87,6 +90,8 @@
 ]}.
 
 {deps, [
+    {elmdb, {git, "https://github.com/samcamwilliams/elmdb", {ref, "5feb2b039e40adb3b2b70241d1c212ad162f5659"}}},
+    {lmdb, {git, "https://github.com/twilson63/erlang-lmdb", {ref, "8a4fedc38c7a44eef6af816b5e840bd362d67f1a"}}},
 	{b64fast, {git, "https://github.com/ArweaveTeam/b64fast.git", {ref, "58f0502e49bf73b29d95c6d02460d1fb8d2a5273"}}},
 	{cowboy, {git, "https://github.com/ninenines/cowboy", {ref, "022013b6c4e967957c7e0e7e7cdefa107fc48741"}}},
 	{gun, {git, "https://github.com/ninenines/gun", {ref, "8efcedd3a089e6ab5317e4310fed424a4ee130f8"}}},
@@ -107,7 +112,7 @@
 {eunit_opts, [verbose]}.
 
 {relx, [
-	{release, {'hb', "0.0.1"}, [hb, b64fast, cowboy, gun, luerl, prometheus, prometheus_cowboy]},
+	{release, {'hb', "0.0.1"}, [hb, b64fast, cowboy, gun, luerl, prometheus, prometheus_cowboy, elmdb]},
 	{include_erts, true},
 	{extended_start_script, true},
 	{overlay, [
@@ -133,6 +138,11 @@
         [
             {eunit, "--module dev_lua_test"}
         ]
+    },
+    {'deploy-scripts',
+        [
+            {shell, "--eval hb:deploy_scripts()."}
+        ]
     }
 ]}.
 

.vscode/launch.json

@@ -12,10 +12,18 @@
   {git,"https://github.com/ninenines/cowlib",
        {ref,"1c3d5defba28e92a88ce45c440d57e178ab1c514"}},
   1},
+ {<<"elmdb">>,
+  {git,"https://github.com/samcamwilliams/elmdb",
+       {ref,"5feb2b039e40adb3b2b70241d1c212ad162f5659"}},
+  0},
  {<<"gun">>,
   {git,"https://github.com/ninenines/gun",
        {ref,"8efcedd3a089e6ab5317e4310fed424a4ee130f8"}},
   0},
+ {<<"lmdb">>,
+  {git,"https://github.com/twilson63/erlang-lmdb",
+       {ref,"8a4fedc38c7a44eef6af816b5e840bd362d67f1a"}},
+  0},
  {<<"luerl">>,{pkg,<<"luerl">>,<<"1.3.0">>},0},
  {<<"prometheus">>,{pkg,<<"prometheus">>,<<"4.11.0">>},0},
  {<<"prometheus_cowboy">>,{pkg,<<"prometheus_cowboy">>,<<"0.1.8">>},0},

config.flat

@@ -203,11 +203,25 @@ end
 -- Register a new host to a route.
 function register(state, assignment, opts)
     state = ensure_defaults(state)
+    ao.event({"register", { state = state, assignment = assignment, opts = opts }})
     local req = assignment.body
+
+    -- If the message is signed by an explicitly trusted peer, we can skip the
+    -- is-admissible check.
+    if state["trusted-peer"] then
+        local committers = ao.get("committers", req)
+        for _, committer in ipairs(committers) do
+            if committer == state["trusted-peer"] then
+                state = add_node(state, req)
+                return recalculate(state, assignment, opts)
+            end
+        end
+    end
+
     req.path = state["is-admissible"].path or "is-admissible"
     local status, is_admissible = ao.resolve(state["is-admissible"], req)
 
-    ao.event("is-admissible result:", { status, is_admissible })
+    ao.event({"is-admissible result:", { status, is_admissible }})
     if status == "ok" and is_admissible == "true" then
         state = add_node(state, req)
         return recalculate(state, assignment, opts)
@@ -270,11 +284,11 @@ function duration(state, assignment, opts)
 end
 
 function compute(state, assignment, opts)
-    if assignment.body.path == "register" then
+    if assignment.body.action == "register" then
         return register(state, assignment, opts)
-    elseif assignment.body.path == "recalculate" then
+    elseif assignment.body.action == "recalculate" then
         return recalculate(state, assignment, opts)
-    elseif assignment.body.path == "performance" then
+    elseif assignment.body.action == "performance" then
         return duration(state, assignment, opts)
     else
         -- If we have been called without a relevant path, simply ensure that
@@ -377,7 +391,7 @@ function performance_test()
     -- Record the starting scores for the nodes
     local t0_node1_score = state.routes[1].nodes[1].weight
     local t0_node2_score = state.routes[1].nodes[1].weight
-  
+
     if t0_node1_score ~= t0_node2_score then
         error("Initial node scores should be equal. Received: "
             .. tostring(t0_node1_score) .. " and " .. tostring(t0_node2_score))
@@ -403,7 +417,7 @@ function performance_test()
             state = state
         }}
     )
-  
+
     -- now trigger a recalc
     _, state = recalculate(state, { body = { path = "recalculate" } }, {})
 
@@ -429,6 +443,6 @@ function performance_test()
     if t1_node2_score >= t0_node2_score then
         error("Node 2 score should have decreased!")
     end
-    
+
     return "ok"
 end

rebar.config

@@ -0,0 +1,41 @@
+--- A simple script that can be used as a `~p4@1.0` ledger device, marshalling
+--- requests to a local process.
+
+-- Find the user's balance in the current ledger state.
+function balance(base, request)
+    local status, res = ao.resolve({
+        path =
+            base["ledger-path"]
+            .. "/now/balance/"
+            .. request["target"]
+    })
+    ao.event({ "client received balance response", 
+        { status = status, res = res, target = request["target"] } }
+    )
+    -- If the balance request fails (most likely because the user has no balance),
+    -- return a balance of 0.
+    if status ~= "ok" then
+        return "ok", 0
+    end
+
+    -- We have successfully retrieved the balance, so return it.
+    return "ok", res
+end
+
+-- Charge the user's balance in the current ledger state.
+function charge(base, request)
+    ao.event("debug_charge", {
+        "client starting charge",
+        { request = request, base = base }
+    })
+    local status, res = ao.resolve({
+        path = "(" .. base["ledger-path"] .. ")/push",
+        method = "POST",
+        body = request
+    })
+    ao.event("debug_charge", {
+        "client received charge response",
+        { status = status, res = res }
+    })
+    return "ok", res
+end

rebar.lock

@@ -0,0 +1,61 @@
+--- An extension to the `hyper-token.lua` script, for execution with the
+--- `lua@5.3a` device. This script adds the ability for an `admin' account to
+--- charge a user's account. This is useful for allowing a node operator to
+--- collect fees from users, if they are running in a trusted execution
+--- environment.
+--- 
+--- This script must be added as after the `hyper-token.lua` script in the
+--- `process-definition`s `script` field.
+
+-- Process an `admin' charge request:
+-- 1. Verify the sender's identity.
+-- 2. Ensure that the quantity and account are present in the request.
+-- 3. Debit the source account.
+-- 4. Increment the balance of the recipient account.
+function charge(base, assignment)
+    ao.event("debug_charge", { "Charge received: ", { assignment = assignment } })
+    local admin = base.admin
+    local status, res, request = validate_request(base, assignment)
+    if status ~= "ok" then
+        return status, res
+    end
+
+    -- Verify that the request is signed by the admin.
+    local committers = ao.get("committers", {"as", "message@1.0", assignment.body})
+    ao.event("debug_charge", { "Validating request: ", {
+        committers = committers,
+        admin = admin
+    } })
+    if count_common(committers, admin) ~= 1 then
+        return "error", base
+    end
+
+    -- Ensure that the quantity and account are present in the request.
+    if not request.quantity or not request.account then
+        ao.event({ "Failure: Quantity or account not found in request.",
+            { request = request } })
+        base.result = {
+            status = "error",
+            error = "Quantity or account not found in request."
+        }
+        return "ok", base
+    end
+
+    -- Debit the source. Note: We do not check the source balance here, because
+    -- the node is capable of debiting the source at-will -- even it puts the
+    -- source into debt. This is important because the node may estimate the
+    -- cost of an execution at lower than its actual cost. Subsequently, the
+    -- ledger should at least debit the source, even if the source may not
+    -- deposit to restore this balance.
+    ao.event({ "Debit request validated: ", { assignment = assignment } })
+    base.balance = base.balance or {}
+    base.balance[request.account] =
+        (base.balance[request.account] or 0) - request.quantity
+
+    -- Increment the balance of the recipient account.
+    base.balance[request.recipient] =
+        (base.balance[request.recipient] or 0) + request.quantity
+
+    ao.event("debug_charge", { "Charge processed: ", { balances = base.balance } })
+    return "ok", base
+end