wiki-plugin-allyabase 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Planet Nine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,165 @@
+# Federated Wiki - allyabase plugin
+
+allyabase is a Backend as a Service (BaaS) similar to Firebase and Supabase except it is open, and interoperable with other systems that utilize the [Sessionless] protocol. 
+allyabase has many features, but the few that are exposed at this time in wiki are enable the signing of smart contracts, and the subsequent creation and/or transfer of nineum tokens upon completed parameters from the contracts. 
+To facilitate this, the plugin exposes the following routes to the client:
+
+<details>
+ <summary><code>GET</code> <code><b>/plugin/allyabase/user/:pubKey</b></code> <code>Gets an existing user by public key</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | pubKey       |  true     | string (hex)            | the publicKey of the user's keypair  |
+
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `USER`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+
+</details>
+
+<details>
+ <summary><code>GET</code> <code><b>/plugin/allyabase/bdo</b></code> <code>Gets the user's BDO</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | pubKey       |  true     | string (hex)            | the publicKey of the user's keypair  |
+
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `USER`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+
+</details>
+
+<details>
+ <summary><code>PUT</code> <code><b>/plugin/allyabase/bdo</b></code> <code>Puts a new bdo or updates the bdo for the user</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | pubKey       |  true     | string (hex)            | the publicKey of the user's keypair  |
+> | bdo          |  true     | object                  | the signature from sessionless for the message  |
+
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `USER`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+
+</details>
+
+<details>
+ <summary><code>POST</code> <code><b>/plugin/allyabase/grant-nineum</b></code> <code>grants a nineum to a user. Requires the wiki owner to have an admin or galactic nineum</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | toUUID       |  true     | string (hex)            | the uuid of the user to grant the nineum  |
+> | flavor       |  true     | string (hex)            | the flavor of nineum to grant |
+
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `USER`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+
+</details>
+
+<details>
+ <summary><code>POST</code> <code><b>/plugin/allyabase/grant-admin-nineum</b></code> <code>grants an admin nineum to a user</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | toUUID       |  true     | string (hex)            | the uuid of the user to grant the nineum  |
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `USER`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+
+</details>
+
+<details>
+ <summary><code>POST</code> <code><b>/plugin/allyabase/transfer</b></code> <code>transfer nineum to another user</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | toUUID       |  true     | string (hex)            | the uuid of the user to grant the nineum  |
+> | nineum       |  true     | array of nineum hex strings | the nineum to transfer |
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `USER`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+
+</details>
+
+<details>
+ <summary><code>GET</code> <code><b>/plugin/allyabase/sign/:thing</b></code> <code>creates a signature from the thing to sign</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | thing        |  true     | string                  | the uuid of the user to grant the nineum  |
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `{signature: <signature>}`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`                            |
+
+</details>
+
+<details>
+ <summary><code>GET</code> <code><b>/plugin/allyabase/verify</b></code> <code>verifies a signature</code></summary>
+
+##### Parameters
+
+> | name         |  required     | data type               | description                                                           |
+> |--------------|-----------|-------------------------|-----------------------------------------------------------------------|
+> | signature    |  true     | string (hex)            | the signature to verify  |
+> | message      |  true     | string                  | the message to check |
+
+##### Responses
+
+> | http code     | content-type                      | response                                                            |
+> |---------------|-----------------------------------|---------------------------------------------------------------------|
+> | `200`         | `application/json`                | `USER`   |
+> | `400`         | `application/json`                | `{"code":"400","message":"Bad Request"}`
+|
+
+</details>
+
+## License
+
+MIT
+
+[Sessionless]: https://github.com/planet-nine-app/sessionless
+

package/client/allyabase.js

@@ -0,0 +1,58 @@
+let allyabaseUser;
+
+async function post(url, payload) {
+  return await fetch(url, {
+    method: 'post',
+    body: JSON.stringify(payload),
+    headers: {'Content-Type': 'application/json'}
+  });
+};
+
+function getPage($item) {
+  return $item.parents('.page').data('data');
+};
+
+function getAllyabaseUser(item) {
+  if(item.allyabaseUser) {
+    return item.allyabaseUser;
+  } else {
+    return fetch('/plugin/allyabase/user').then(res => res.json());
+  }
+};
+
+function emit($item, item) {
+  $item.empty(item);
+
+  const gettingUserDiv = document.createElement('div');
+  gettingUserDiv.innerHTML = '<p>Getting your allyabase user, and signatures...</p>';
+  $item.append(gettingUserDiv);
+  let user;
+
+  getAllyabaseUser(item)
+    .then(_allyabaseUser => {
+console.log('item is now', item);
+      allyabaseUser = _allyabaseUser;
+
+      addExplainer();
+      addFeeds();
+      addContracts();
+      addInventory();
+    })
+    .catch(err => console.warn('received an error emitting in contract plugin', err))
+    .finally(() => {
+console.log('finally');
+      bind($item, item);
+    });
+};
+
+function bind($item, item) {
+console.log('bind called');
+
+onsole.log('listeners added');
+};
+
+if(window) {
+  window.plugins['contract'] = {emit, bind};
+}
+
+export const contract = typeof window == 'undefined' ? { emit, bind } : undefined;

package/factory.json

@@ -0,0 +1,5 @@
+{
+  "name": "allyabase",
+  "title": "Allyabase Plugin",
+  "category": "other"
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "wiki-plugin-allyabase",
+  "version": "0.0.1",
+  "description": "Allyabase plugin for the federated wiki",
+  "keywords": [
+    "wiki",
+    "federated",
+    "sessionless",
+    "planet-nine"
+  ],
+  "homepage": "https://github.com/planet-nine-app/wiki-plugin-contract#readme",
+  "bugs": {
+    "url": "https://github.com/planet-nine-app/wiki-plugin-contract/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/planet-nine-app/wiki-plugin-contract.git"
+  },
+  "license": "MIT",
+  "author": "planetnineisaspaceship",
+  "type": "commonjs",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "allyabase-js": "latest",
+    "magic-gateway-js": "latest",
+    "sessionless-node": "latest"
+  }
+}

package/server/contracts.js

@@ -0,0 +1,256 @@
+var _gateway = require('magic-gateway-js');
+var _fount = require('fount-js');
+var _bdo = require('bdo-js');
+var sessionless = require('sessionless-node');
+var fs = require('fs');
+
+const gateway = _gateway.default;
+const fount = _fount.default;
+const bdo = _bdo.default;
+
+fount.baseURL = 'http://localhost:3006/';
+bdo.baseURL = 'http://localhost:3003/';
+
+const HASH = 'contract';
+
+let fountUser;
+
+async function addRoutes(params) {
+  const app = params.app;
+  const argv = params.argv;
+
+  let allyabaseUser = {};
+  
+  const allyabaseKeys = {
+    privateKey: argv.private_key,
+    pubKey: argv.pub_key
+  };
+
+  const saveKeys = () => {};
+  const getKeys = () => allyabaseKeys;
+
+  await fount.createUser(saveKeys, getKeys);
+  await bdo.createUser({}, HASH, saveKeys, getKeys);
+
+  await sessionless.generateKeys(saveKeys, getKeys);
+
+  app.get('/plugin/allyabase/owner', async function(req, res) {
+console.log('calling owner');
+    const idFile = argv.id;
+console.log('idFile', idFile);
+    fs.readFile(idFile, (err, data) => {
+      if(err) {
+console.log('err', err);
+        res.status(404);
+        return res.send(err);
+      }
+      const owner = JSON.parse(data);
+      res.send(owner);
+    });
+  });
+
+//  app.get('/plugin/allyabase/user', async function(req, res) {
+console.log('getting called here');
+    let fountUser;
+    let bdoUUID;
+
+    if(!allyabaseUser || !fountUser) {
+console.log('fount looks like', fount);
+      fountUser = await fount.getUserByPublicKey(argv.pub_key);
+      if(!fountUser || !fountUser.uuid) {
+        fountUser = await fount.createUser(saveKeys, getKeys);   
+      }
+    }
+
+    if(!allyabaseUser || !allyabaseUser.bdoUser) {
+      bdoUUID = await bdo.createUser(HASH, {}, saveKeys, getKeys);
+      allyabaseUser.bdoUser = {bdo: {}, uuid: bdoUUID};
+    }
+    
+    allyabaseUser.bdoUser = await bdo.getBDO(allyabaseUser.bdoUser.uuid, HASH);
+    allyabaseUser.fountUser = fountUser;
+    allyabaseUser.nineum = await fount.getNineum(allyabaseUser.fountUser.uuid);
+console.log('allyabaseUser is: ', allyabaseUser);
+
+    let galacticNineum = allyabaseUser.nineum.filter(nineum => nineum.slice(14, 16) === 'ff');
+    if(!galacticNineum || galacticNineum.length < 1) {
+      try {
+        allyabaseUser.fountUser = await fount.grantGalacticNineum(allyabaseUser.fountUser.uuid, '28880014');
+      } catch(err) {
+console.log('grave error getting galaxy bud', err);
+      }
+    } 
+
+//    res.send(allyabaseUser);
+//  });
+
+  app.post('/plugin/allyabase/resolve', async function(req, res) {
+    const payload = req.body;
+    const message = JSON.stringify({
+      timestamp: payload.timestamp,
+      spell: payload.spell,
+      casterUUID: payload.casterUUID,
+      totalCost: payload.totalCost,
+      mp: payload.mp,
+      ordinal: payload.ordinal,
+    });
+
+    payload.casterSignature = await sessionless.sign(message);
+
+    const resolution = await fount.resolve(payload);
+    if(resolution.success) {
+      const updatedUser = await fount.getUserByUUID(payload.casterUUID);
+      return res.send(updatedUser);
+    }
+    res.send(resolution);
+  });
+
+  app.get('/plugin/allyabase/user/:pubKey', async function(req, res) {
+    fountUser = await fount.getUserByPublicKey(req.params.pubKey);
+console.log('getting the user on the server, it looks like: ', fountUser);
+    fountUser.nineum = await fount.getNineum(fountUser.uuid);
+    res.send(fountUser);
+  });
+
+  app.get('/plugin/allyabase/bdo', async function(req, res) {
+    try {
+     const bdoResp = await bdo.getBDO(allyabaseUser.bdoUser.uuid, HASH, req.query.pubKey);
+     res.send(bdoResp);
+   } catch(err) {
+     res.status(404);
+     res.send(err);
+   }
+  });
+
+  app.put('/plugin/allyabase/bdo', async function(req, res) {
+    try {
+      allyabaseUser.bdoUser = await bdo.updateBDO(allyabaseUser.bdoUser.uuid, HASH, req.body.bdo);
+      res.send({success: true});
+    } catch(err) {
+      res.status(404);
+      res.send(err);
+    }
+  });
+
+  app.post('/plugin/allyabase/grant-nineum', async function(req, res) {
+    const toUUID = req.body.toUUID;
+    const flavor = req.body.flavor;
+console.log('granting nineum to', toUUID);
+console.log('with flavor ', flavor);
+
+    if(!allyabaseUser.fountUser) {
+      allyabaseUser.fountUser = await fount.getUserByPublicKey(argv.pub_key);
+    }
+
+    const grantee = await fount.grantNineum(allyabaseUser.fountUser.uuid, toUUID, flavor);
+console.log('the grantee now looks like: ', grantee);
+    res.send(grantee);
+  });
+
+  app.post('/pugin/allyabase/grant-admin-nineum', async function(req, res) {
+    const toUUID = req.body.toUUID;
+
+    const grantee = await fount.grantAdminNineum(allyabaseUser.fountUser.uuid, toUUID);
+    res.send(grantee);
+  });
+
+  app.post('/plugin/allyabase/transfer', async function(req, res) {
+    const uuid = allyabaseUser.fountUser.uuid;
+    const toUUID = req.body.toUUID;
+    const nineum = req.body.nineum;
+    const transferNineum = await fount.transferNineum(uuid, toUUID, nineum, 0, 'usd'); // priced transfers not supported yet
+console.log('response on server for transfer', transferNineum);
+    fountUser = await fount.getUserByPublicKey(req.params.pubKey);
+console.log('getting the user on the server, it looks like: ', fountUser);
+    fountUser.nineum = await fount.getNineum(fountUser.uuid);
+    res.send(fountUser);
+  });
+
+  app.get('/plugin/allyabase/sign/:thing', function(req, res) {
+    var _getKeys;
+    _getKeys = sessionless.getKeys;
+    signatureKeys = {
+      privateKey: argv.private_key,
+      pubKey: argv.pub_key
+    };
+    sessionless.getKeys = function() {
+      console.log("this should be in sign, and returning", signatureKeys);
+      return signatureKeys;
+    };
+    return sessionless.sign(req.params.thing).then(function(signature) {
+      console.log('signature', signature);
+      res.json({signature});
+    }).catch(function(err) {
+      console.error(err);
+      return res.sendStatus(404);
+    }).finally(function() {
+      return sessionless.getKeys = _getKeys;
+    });
+  });
+
+  app.get('/plugin/allyabase/verify', function(req, res) {
+    var message, pubKey, signature, verified;
+    console.log('query is: ', req.query);
+    signature = req.query.signature;
+    message = req.query.message;
+    pubKey = argv.pub_key;
+    verified = sessionless.verifySignature(signature, message, pubKey);
+    return res.send({verified});
+  });
+
+  app.get('/plugin/allyabase/abelard', async function(req, res) {
+    try {
+console.log('req.query is', req.query);
+      const transfereeUUID = req.query.uuid;
+      const transfereeHost = req.query.host;
+
+console.log('allyabaseUser here is', allyabaseUser);
+      const userBDO = await bdo.getBDO(allyabaseUser.bdoUser.uuid, HASH);
+console.log('this bdo is', userBDO);
+      userBDO.bdo.transferees = userBDO.bdo.transferees || {};
+      userBDO.bdo.transferees[transfereeUUID] = transfereeHost;
+
+      const updatedBDO = await bdo.updateBDO(allyabaseUser.bdoUser.uuid, HASH, userBDO.bdo);
+console.log('updatedBDO is', updatedBDO);
+
+      res.send({success: true});
+    } catch(err) {
+console.log(err);
+      res.status(404);
+      res.send({err});
+    }
+  });
+
+  const spellbook = {
+    spellbookName: 'ReaLocalize',
+    contract: {
+      cost: 1,
+      destinations: [
+        {stopName: 'contract-wiki', stopURL: 'http://127.0.0.1:4444/plugin/magic/spell/'},
+        {stopName: 'fount', stopURL: 'http://127.0.0.1:3006/resolve/'}
+      ]
+    }
+  };
+
+  const myStopName = 'contract-wiki';
+
+  const extraForGateway = (spellName) => {
+    if(spellName === 'contract') {
+      return 'contractUUID';
+    }    
+  };
+
+  const onSuccess = (req, res, result) => {
+    const spell = req.body;
+    const casterUUID = spell.casterUUID;
+    const targetUUID = spell.gateways[0].uuid;
+    const flavor = 'e1e1e1e1e1e1';
+
+    fount.grantNineum(targetUUID, casterUUID, flavor);
+    res.send(result);
+  };
+
+  gateway.expressApp(app, allyabaseUser.fountUser, spellbook, myStopName, sessionless, extraForGateway, onSuccess);
+}
+
+module.exports = {addRoutes};

package/server/feeds.js

@@ -0,0 +1,27 @@
+var { dolores } = require('allyabase-js');
+var sessionless = require('sessionless-node');
+var fs = require('fs');
+
+async function addRoutes(params) {
+  const app = params.app;
+  const argv = params.argv;
+
+  const allyabaseKeys = {
+    privateKey: argv.allyabase_private_key,
+    pubKey: argv.allyabase_pub_key
+  };
+
+  let doloresUser;
+
+  doloresUser = await dolores.getUser(allyabaseKeys.pubKey);
+  if(!doloresUser) {
+    doloresUser = await dolores.createUser(saveKeys, getKeys);
+  }
+
+  app.get('/plugin/allyabase/feeds', async function(req, res) {
+    const updatedUser = await dolores.getUser(doloresUser.uuid);
+    res.send(updatedUser.feeds);
+  });
+};
+
+module.exports = {addRoutes};

package/server/inventory.js

@@ -0,0 +1,82 @@
+var _fount = require('fount-js');
+var _bdo = require('bdo-js');
+var sessionless = require('sessionless-node');
+var fs = require('fs');
+
+const gateway = _gateway.default;
+const fount = _fount.default;
+const bdo = _bdo.default;
+
+fount.baseURL = 'http://localhost:3006/';
+bdo.baseURL = 'http://localhost:3003/';
+
+const HASH = 'contract';
+
+let fountUser;
+
+async function addRoutes(params) {
+  const app = params.app;
+  const argv = params.argv;
+
+  let allyabaseUser = {};
+  
+  const allyabaseKeys = {
+    privateKey: argv.private_key,
+    pubKey: argv.pub_key
+  };
+
+  const saveKeys = () => {};
+  const getKeys = () => allyabaseKeys;
+
+  await fount.createUser(saveKeys, getKeys);
+  await bdo.createUser({}, HASH, saveKeys, getKeys);
+
+  await sessionless.generateKeys(saveKeys, getKeys);
+
+console.log('getting called here');
+  let fountUser;
+  let bdoUUID;
+
+  if(!allyabaseUser || !fountUser) {
+console.log('fount looks like', fount);
+    fountUser = await fount.getUserByPublicKey(argv.pub_key);
+    if(!fountUser || !fountUser.uuid) {
+      fountUser = await fount.createUser(saveKeys, getKeys);   
+    }
+  }
+
+  if(!allyabaseUser || !allyabaseUser.bdoUser) {
+    bdoUUID = await bdo.createUser(HASH, {}, saveKeys, getKeys);
+    allyabaseUser.bdoUser = {bdo: {}, uuid: bdoUUID};
+  }
+  
+  allyabaseUser.bdoUser = await bdo.getBDO(allyabaseUser.bdoUser.uuid, HASH);
+  allyabaseUser.fountUser = fountUser;
+  allyabaseUser.nineum = await fount.getNineum(allyabaseUser.fountUser.uuid);
+console.log('allyabaseUser is: ', allyabaseUser);
+
+  app.get('/plugin/allyabase/fount-user', async function(req, res) {
+console.log('getting called here');
+    let user;
+
+    if(!uuid) {
+      user = await fount.getUserByPublicKey(fountKeys.pubKey);
+console.log('user looks like', user);
+      if(!user || !user.uuid) {
+        user = await fount.createUser(saveKeys, getKeys);
+      }
+    } else {
+      user = await fount.getUserByUUID(uuid);
+    }
+console.log('user is: ', user);
+    user.nineum = await fount.getNineum(user.uuid);
+
+    uuid = user.uuid;
+    allyabase.fountUser = user;
+
+    res.send(user);
+  });
+
+}
+
+module.exports = {addRoutes};

package/server/server.js

@@ -0,0 +1,13 @@
+const contract = require('./contract.js');
+const feeds = require('./feeds.js');
+const inventory = require('./inventory.js');
+(function() {
+  async function startServer(params) {
+    contract.addRoutes(params);
+    feeds.addRoutes(params);
+    inventory.addRoutes(params);
+  };
+}
+
+module.exports = {startServer};
+}).call(this);

package/test/node_modules/.bin/_mocha

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+'use strict';
+
+/**
+ * This file remains for backwards compatibility only.
+ * Don't put stuff in this file.
+ * @see module:lib/cli
+ */
+
+require('../lib/cli').main();