@hazae41/bobine 0.0.7 → 0.0.9

package/README.md

@@ -4,6 +4,8 @@ A blockchain in your garage
 
 https://bobine.tech/
 
+[**📦 NPM**](https://www.npmjs.com/package/@hazae41/bobine) • [**📦 JSR**](https://jsr.io/@hazae41/bobine)
+
 ## Features
 
 - Ultra simple
@@ -15,11 +17,19 @@ https://bobine.tech/
 
 \* There are no built-in accounting concepts, only pure generic APIs for cryptography and storage
 
-## Running
+## Usage
+
+### Running the server
+
+#### Running the server via binary
 
-### Binary
+Install the binary with Deno
 
-Generate an Ed25519 keypair by running the following code in your browser/Node/Deno console
+```bash
+deno install -gf -A jsr:@hazae41/bobine
+```
+
+Generate an Ed25519 keypair by running the following code in your browser/deno/node/bun console
 
 ```typescript
 const keypair = await crypto.subtle.generateKey("Ed25519", true, ["sign", "verify"])
@@ -44,19 +54,35 @@ ED25519_PRIVATE_KEY_HEX=302e020100300506032b657004220420edff8b2503b91f58bc0f0435
 ED25519_PUBLIC_KEY_HEX=90dcd81a473a4e59a84df6cb8f77af3d34c7fd6171ed959ca04a75f07a57b4b9
 ```
 
-Run the server with Deno
+Run the server
 
 ```bash
-deno run -A jsr:@hazae41/bobine serve --env=./.env.local
+bobine serve --env=./.env.local
 ```
 
-### Library
+#### Running the server via library
 
 Install `@hazae41/bobine` and use the `serve()` function
 
-## HTTP API
+### Creating a module
+
+#### Creating a module via binary
 
-### POST /api/create
+Install the binary with Deno
+
+```bash
+deno install -gf -A jsr:@hazae41/bobine
+```
+
+Deploy your .wasm file
+
+```bash
+bobine create ./module.wasm --server=http://localhost:8080
+```
+
+### Using the HTTP API
+
+#### POST /api/create
 
 Creates a new module using some WebAssembly code and some unique salt
 
@@ -68,7 +94,7 @@ Accepts a form data with the following fields
 
 - `effort` as bytes = some unique 32 bytes whose sha256 `hash` validates `((2n ** 256n) / BigInt("0x" + hash.toHex())) > (code.length + salt.length)`
 
-### POST /api/execute
+#### POST /api/execute
 
 Execute some function on a module
 
@@ -82,7 +108,7 @@ Accepts a form data with the following fields
 
 - `effort` as bytes =  some unique 32 bytes whose sha256 `hash` whose result in `((2n ** 256n) / BigInt("0x" + hash.toHex()))` will be the maximum number of sparks (gas) used
 
-### POST /api/simulate
+#### POST /api/simulate
 
 Simulate some function on a module (it won't write anything to storage and will execute in mode `2` so verifications such as signatures can be skipped)
 
@@ -96,11 +122,11 @@ Accepts a form data with the following fields
 
 - `effort` as bytes =  some unique 32 bytes whose sha256 `hash` whose result in `((2n ** 256n) / BigInt("0x" + hash.toHex()))` will be the maximum number of sparks (gas) used
 
-## WebAssembly API
+### Using the WebAssembly API
 
 The WebAssembly VM extensively uses reference types for its API and for module-to-module communication
 
-### AssemblyScript
+#### Using the WebAssembly API via AssemblyScript
 
 You can use [stdbob](https://github.com/hazae41/stdbob) to easily import AssemblyScript declarations for all internal modules
 
@@ -118,9 +144,7 @@ And you can declare external modules by using the module address as hex
 declare function add(x: externref, y: externref): externref
 ```
 
-### All internal modules
-
-#### blobs
+#### Blobs module
 
 You can pass bytes between modules by storing them in the blob storage and loading them via reference
 
@@ -134,7 +158,7 @@ You can pass bytes between modules by storing them in the blob storage and loadi
 
 - `blob.to_hex/from_hex/to_base64/from_base64(blob: blobref): blobref` = convert blobs to/from hex/base64 without loading them into memory
 
-#### bigints
+#### BigInts module
 
 You can work with infinite-precision bigints
 
@@ -160,7 +184,7 @@ You can work with infinite-precision bigints
 
 - `bigints.from_base10(base16: blobref): bigintref` = convert base10 utf8 bytes to bigint
 
-#### packs
+#### Packs module
 
 You can pack various arguments (numbers, refs) into a pack which can be passed between modules and/or encoded/decoded into bytes
 
@@ -217,7 +241,7 @@ function writePack(pack: packref) {
 
 - `packs.length(pack: packref): i32` = get the length of a pack
 
-#### env
+#### Environment module
 
 Get infos about the executing environment
 
@@ -225,7 +249,7 @@ Get infos about the executing environment
 
 - `env.uuid(): blobref` = get the unique uuid of this environment (similar to a chain id)
 
-#### modules
+#### Modules module
 
 Modules are identified by their address as a blob of bytes (pure sha256-output 32-length bytes without any encoding)
 
@@ -237,7 +261,7 @@ Modules are identified by their address as a blob of bytes (pure sha256-output 3
 
 - `modules.self(): blobref` = get your module address as blob
 
-#### storage
+#### Storage module
 
 You can use a private storage (it works like storage and events at the same time)
 
@@ -245,13 +269,13 @@ You can use a private storage (it works like storage and events at the same time
 
 - `storage.get(key: blobref): blobref` = get the latest value from storage at key
 
-#### sha256
+#### SHA-256 module
 
 Use the SHA-256 hashing algorithm
 
 - `sha256.digest(payload: blobref): blobref` = hash the payload and returns the digest
 
-#### ed25519
+#### Ed25519 module
 
 Use the Ed25519 signing algorithm
 
@@ -259,11 +283,11 @@ Use the Ed25519 signing algorithm
 
 - `ed25519.sign(payload: blobref): blobref` = (experimental) sign payload using the miner's private key
 
-#### symbols (experimental)
+#### Symbols module (experimental)
 
 - `symbols.create(): symbolref` = create a unique reference that can be passed around
 
-#### refs (experimental)
+#### References module (experimental)
 
 - `refs.numerize(ref: symbolref/blobref/packref): i32` = translate any reference into a unique private pointer that can be stored into data structures
 

package/out/mod.js

@@ -15,24 +15,9 @@ export async function main(args) {
             await server.main(subargs);
             return;
         }
-        if (arg === "create") {
-            console.log("Create command is not implemented yet.");
-            return;
-        }
-        if (arg === "execute") {
-            console.log("Execute command is not implemented yet.");
-            return;
-        }
-        if (arg === "simulate") {
-            console.log("Simulate command is not implemented yet.");
-            return;
-        }
         break;
     }
-    console.log("- serve [--env=<env file as path>] [--port=<port>] [--dev]");
-    console.log("- create <wasm file as path> [salt as hex]");
-    console.log("- execute <module as hex> <function name> [args as pack as hex]");
-    console.log("- simulate <module as hex> <function name> [args as pack as hex]");
+    console.log("serve [--env=<env file as path>] [--port=<port>] [--dev]");
     return;
 }
 if (import.meta.main) {

package/out/mods/server/bin.js

@@ -2,7 +2,7 @@ import { readFileSync } from "node:fs";
 import process from "node:process";
 import { serveWithEnv } from "./mod.js";
 export async function main(args) {
-    const config = {};
+    const options = {};
     for (let i = 0; i < args.length; i++) {
         const arg = args[i];
         if (arg.startsWith("--env=")) {
@@ -10,15 +10,15 @@ export async function main(args) {
             continue;
         }
         if (arg.startsWith("--port=")) {
-            config.port = Number(arg.slice("--port=".length));
+            options.port = Number(arg.slice("--port=".length));
             continue;
         }
         if (arg.startsWith("--cert=")) {
-            config.cert = readFileSync(arg.slice("--cert=".length), "utf8");
+            options.cert = readFileSync(arg.slice("--cert=".length), "utf8");
             continue;
         }
         if (arg.startsWith("--key=")) {
-            config.key = readFileSync(arg.slice("--key=".length), "utf8");
+            options.key = readFileSync(arg.slice("--key=".length), "utf8");
             continue;
         }
         if (arg === "--dev=true") {
@@ -35,7 +35,7 @@ export async function main(args) {
         }
         throw new Error(`Unknown argument: ${arg}`);
     }
-    const { port = Number(process.env.PORT) || 8080, cert = process.env.CERT != null ? readFileSync(process.env.CERT, "utf8") : undefined, key = process.env.KEY != null ? readFileSync(process.env.KEY, "utf8") : undefined, } = config;
+    const { port = Number(process.env.PORT) || 8080, cert = process.env.CERT != null ? readFileSync(process.env.CERT, "utf8") : undefined, key = process.env.KEY != null ? readFileSync(process.env.KEY, "utf8") : undefined, } = options;
     const server = await serveWithEnv();
     const route = async (request) => {
         if (request.method === "OPTIONS")

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@hazae41/bobine",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "A blockchain in your garage",
   "repository": "github:hazae41/bobine",
   "author": "hazae41",
@@ -46,6 +46,6 @@
     "unit-tested"
   ],
   "bin": {
-    "bobine": "./out/bin.js"
+    "bobine": "./out/mod.js"
   }
 }