@oasisomniverse/web4-api 2.0.0 → 2.0.1

package/README.md

@@ -1,82 +1,40 @@
-# WEB4 OASIS API Javascript Package
+# @oasisomniverse/web4-api
 
-- [WEB4 OASIS API Javascript Package](#web4-oasis-api-javascript-package)
+- [@oasisomniverse/web4-api](#oasisomniverseweb4-api)
+  - [About WEB4](#about-web4)
   - [Previous Versions](#previous-versions)
-  - [Introduction](#introduction)
-  - [Overview](#overview)
-    - [Best Of All Worlds](#best-of-all-worlds)
-    - [Maximum Interopability/Aggregation](#maximum-interopabilityaggregation)
-    - [HOT Swappable Plugin Architecture](#hot-swappable-plugin-architecture)
-    - [Full Redundancy/Zero Downtime/Impossible To Shutdown](#full-redundancyzero-downtimeimpossible-to-shutdown)
-    - [HTTP REST/gRPC/GraphQL/CLI/Native Endpoints](#http-restgrpcgraphqlclinative-endpoints)
-    - [Javascript, Unity & C# Packages](#javascript-unity--c-packages)
-    - [Avatar API](#avatar-api)
-    - [Karma API](#karma-api)
-    - [Full Accountability/Zero Crime/Dark Net Prove](#full-accountabilityzero-crimedark-net-prove)
-    - [Data API](#data-api)
-    - [Future Prove! Never Need To Learn A New Tech Stack/Language Again](#future-prove-never-need-to-learn-a-new-tech-stacklanguage-again)
-    - [SEEDS API](#seeds-api)
-    - [Keys/Wallet API](#keyswallet-api)
-    - [Works Offline/Local Networks (LAN, Bluetooth, Mesh Networks)](#works-offlinelocal-networks-lan-bluetooth-mesh-networks)
-    - [OAPPS - Write Once, Deploy Everywhere](#oapps---write-once-deploy-everywhere)
-    - [One API To Rule Them All - The GOD Protocol/API](#one-api-to-rule-them-all---the-god-protocolapi)
-    - [Full Smart Contract Interoperability](#full-smart-contract-interoperability)
-    - [Powerful Pick n Mix & Plug n Play UI Components](#powerful-pick-n-mix--plug-n-play-ui-components)
-    - [WEB/2D/3D/AR/VR/IR/Map/Meta Visusalization](#web2d3darvrirmapmeta-visusalization)
-    - [Our World Geo-Location/AR/IR/Map UI (Game Of Games Engine)](#our-world-geo-locationarirmap-ui-game-of-games-engine)
-    - [IR (Infinite Reality) Ready](#ir-infinite-reality-ready)
-    - [One World Open World MMO (VR) (Game Of Games Engine)](#one-world-open-world-mmo-vr-game-of-games-engine)
-    - [XR/IR Unified Interface To The World](#xrir-unified-interface-to-the-world)
-    - [ARC/HoloMap/Synergy Engine Integration](#archolomapsynergy-engine-integration)
-    - [WEB 5 STAR OASIS Omniverse Interoperable Metaverse Low Code Generator](#web-5-star-oasis-omniverse-interoperable-metaverse-low-code-generator)
-    - [AI/Machine Learning Over All Of World's Aggregated Data](#aimachine-learning-over-all-of-worlds-aggregated-data)
-    - [Summary](#summary)
+  - [About The OASIS Omniverse](#about-the-oasis-omniverse)
   - [Benefits Of Building On The WEB4 OASIS API](#benefits-of-building-on-the-web4-oasis-api)
   - [WEB 4 OASIS API Packages](#web-4-oasis-api-packages)
     - [Javascript](#javascript)
     - [Unity](#unity)
-    - [C](#c)
+    - [C#](#c)
   - [Do You Want To Get Involved?](#do-you-want-to-get-involved)
-  - [How To Use](#how-to-use)
-  - [Getting started](#getting-started)
-  - [Auth](#auth)
-    - [Login](#login)
-    - [Signup](#signup)
-    - [Logout](#logout)
-    - [Forgot password](#forgot-password)
-    - [Get user](#get-user)
-  - [Avatar](#avatar)
-    - [get](#get)
-    - [Get All](#get-all)
-    - [update](#update)
-    - [delete](#delete)
-    - [addKarma](#addkarma)
-    - [removeKarma](#removekarma)
-  - [Data](#data)
-    - [loadHolon](#loadholon)
-    - [loadAllHolons](#loadallholons)
-    - [loadHolonsForParent](#loadholonsforparent)
-    - [saveHolon](#saveholon)
-    - [saveHolonOffChain](#saveholonoffchain)
-    - [deleteHolon](#deleteholon)
-  - [Karma](#karma)
-    - [getKarmaForAvatar](#getkarmaforavatar)
-    - [removeKarmaForAvatar](#removekarmaforavatar)
-    - [getKarmaAkashicRecordsForAvatar](#getkarmaakashicrecordsforavatar)
-  - [Holochain](#holochain)
-    - [getHolochainAgentIdForAvatar](#getholochainagentidforavatar)
-    - [getHolochainAgentPrivateKeyForAvatar](#getholochainagentprivatekeyforavatar)
-    - [getAvatarIdForHolochainAgentId](#getavataridforholochainagentid)
-    - [getHoloFuelBalanceForAgentId](#getholofuelbalanceforagentid)
-    - [getHoloFuelBalanceForAvatar](#getholofuelbalanceforavatar)
-    - [getHoloFuelBalanceForAvatar](#getholofuelbalanceforavatar-1)
-  - [NFT](#nft)
-    - [createPurchase](#createpurchase)
-    - [getOlandPrice](#getolandprice)
-    - [purchaseOLAND](#purchaseoland)
-  - [Solona](#solona)
-    - [mint](#mint)
-    - [exchange](#exchange)
+  - [Install](#install)
+  - [Quick start](#quick-start)
+  - [Calling any endpoint](#calling-any-endpoint)
+  - [Auth & sessions](#auth--sessions)
+  - [Module examples](#module-examples)
+  - [Module reference](#module-reference)
+  - [Regenerating](#regenerating)
+  - [Testing](#testing)
+  - [Full documentation](#full-documentation)
+
+Isomorphic (Node 18+ and browser) JavaScript/TypeScript-friendly client for the
+**WEB4 OASIS API** - full coverage of the OASIS ONODE WebAPI: Avatar, Karma,
+Data, Wallet, NFT, Holochain, HyperDrive, Keys, Map, Provider and every other
+controller (32 modules, 483 operations).
+
+Zero dependencies. Wraps the global `fetch`. Works the same in Node and the
+browser.
+
+## About WEB4
+
+> **"One avatar, one karma, every world."**
+
+WEB4 is the universal unification layer of the OASIS Omniverse — one avatar, one SSO login and one karma reputation score that works across 40+ blockchains, databases and Web2/Web3 providers, so every world, app and game you build shares the same identity, reputation and wallet. No more silos, no more walled gardens, no single point of failure.
+
+WEB4 is the foundation everything else in the ecosystem is built on top of — see the full **[OASIS Omniverse](https://oasisomniverse.one)** (WEB4 through WEB10) for the bigger picture.
 
 ## Previous Versions
 
@@ -95,262 +53,43 @@ This package starts at `v2.0.0` rather than `v1.0.0` because it is a continuatio
 The current version of this package can be found here:
 https://www.npmjs.com/package/@oasisomniverse/web4-api
 
-## Introduction
-
-This package is for client applications to connect and work with the OASIS API.
-
-## Overview
-
-The WEB4 OASIS API enables you to integrate your project with everything else (WEB2 & WEB3) such as all blockchains, holochain & much more. It also provides SSO, load balancing, auto failover, auto replication, zero downtime, zero lag, infinite players and much more!
-
-Various OASIS API functions and services can be accessed with this API such as Authentication, Karma, Avatars, Data, SEEDS, Wallets/Keys & more...
-
-<http://api.oasisplatform.world>
-
-This allows you to bridge between all of WEB2 & WEB3 Holochain, IPFS, MongoDB, SQLLite, Neo4j, Solana, Ethereum, EOS & ThreeFold with many more coming soon such as COSMOS, Polkadot, Polygon, SOLID, ActivityPub, Near, Nexus, HIVE, CEPTR Pluggable Protocol, Fediverse, XMPP & many more! :) The majority of these are aimed at building a truly decentralised distributed internet (Web 3.0) and this is also the aim of the OASIS API. If you wish to get involved and help build out any of these providers or any other you would like to see integrated please get in touch here: <https://t.me/ourworldthegamechat>.
-
-WEB 4 OASIS API is a fully distributed decentralised fault tolerant load balanced integrated API that runs across the full Internet acting as an abstraction layer over everything and serves as a network of networks. It is unity consciousnes expressed within the technical sphere. [The OASIS API is a global universal API that aims to connect anything to everything](https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK#the-universal-api-to-connect-everything-to-everything--no-more-silos-walled-gardens-) to eliminate walled gardens/silos.
-
-The core OASIS (Open Advanced Sensory Immersion System) API that powers Our World/One World and manages the central profile/avatar/karma system that other satellite apps/games/sites/services plug into it and share. This allows karma to be earnt in the satellite apps/games by doing good deeds or progressing self help apps for example.
-
-### Best Of All Worlds
-
-Just like a team of people, different tech has various strengths and weaknesses, by integrating them together so they work as one unified co-ordinated team, you eliminate all weaknesses and then have the best of all worlds, the whole is greater than the sum of the parts. It harnesses the best of each provider so the OASIS uses the strengths of each provider to the maximum and removes all weaknesses, it automatically uses the most appropriate provider or providers for any given use case.
-
-### Maximum Interopability/Aggregation
-
-One of the core design goals of the OASIS is maximum interoperability (to remove all silos and walled gardens) to the point everything merges into one (the singularity) and also to be super powerful but super easy and intuitive to use.
-
-The WEB4 OASIS API connects & Integrates everything (all of WEB 2 & WEB 3) including all blockchains, holochain, IPFS, databases, cloud etc into one fully unified API that is an abstraction layer over everything.
-
-The whole point of the OASIS API is to allow everything to be fully interoperable so data can be shared between any provider, the architecture opens the doors for many more use cases like importing and exporting your data between providers, aggregating all your data to remove all silos so better sense making and AI machine learning can be made to analyse and to make predictions, smart contract interoperability, etc
-
-### HOT Swappable Plugin Architecture
-
-The OASIS API features a HOT Swappable Plugin Architecture meaning any OASIS Provider can be deployed and used at runtime without having to re-compile or deploy a ONODE (OASIS Node).
-
-### Full Redundancy/Zero Downtime/Impossible To Shutdown
-
-It also allows full data redundancy and for it to be network independent so if one network goes down it can automatically switch to the next fastest node in your area regardless of what network it is on. So it will be impossible to shut the OASIS down, you need to shut the entire Internet down, goodluck with that! ;-)
-
-### HTTP REST/gRPC/GraphQL/CLI/Native Endpoints
-
-The OASIS API currently has a HTTP REST API, CLI & Native endpoints. gRPC & GraphQL are coming soon...
-
-### Javascript, Unity & C# Packages
-
-The OASIS API currently has a [Javascript](#javascript), [Unity](#unity) & [C#](#csharp) package, more are coming soon...
-
-### Avatar API
-
-The OASIS API features a powerful Avatar SSO (Single Sign On) API allowing ONE login across all your sites, games, apps, services, etc across all devices and platforms for your OASIS Avatar where you have FULL control of ALL of your data right down to the individual field level and whether each field is Replicated/Shared (ReadOnly) or Shared (ReadWrite). You no longer need to remember multiple login details, you can have just ONE login (avatar), that follows you everywhere and you have FULL control of. You choose where your data is stored and who has access to it. This avatar is the digital twin of YOU and allows you to earn/lose karma through the Karma API.
-
-### Karma API
-
-The OASIS API also has a powerful Karma API where your avatar (YOU) can earn and lose karma across any OAPP (OASIS App) that is integrated into the OASIS API (websites, apps, games, services, etc). You can earn karma for picking up litter, recycling, going green, helping people, eating/drinking healthily, improving your self or the enviroment, donating to chairty, volunteering for good causes, planting trees, progressing in self help apps, medidation, yoga, mindfulness, spending time in nature, etc. You lose karma for dropping liter, being abusive online, not eating healthily.
-
-This karma is then redeemed for real world goods & services such as for a free smoothie, yoga class, retreat etc.
-
-It also unlocks new gifts and super powers for your avatar in the Our World/One World games that plug into the API, they are the first worlds of the new upcoming OASIS Omniverse (network of metaverses).
-
-### Full Accountability/Zero Crime/Dark Net Prove
-
-The extra benefit of this is that everyone is fully accountable for their actions where their karma & how they earnt/lost it is fully visible to all. There can be no hiding in the OASIS, it makes crime & the dark net impossible!
-
-### Data API
-
-It also features the powerful [Data API](https://www.ourworldthegame.com/single-post/@oasisomniverse/web4-api-v2-3-1-released-with-new-improved-data-api-and-lots-more) allowing data to be shared between the above providers giving full interoperability. It also has powerful features such as auto-fail over, auto-load balancing and auto-replication across the providers so if one node goes down in your local area it will automatically switch to the next fastest node in your area independent of the network it belongs to, this way the OASIS API never has any downtime and will always be super fast and not reliant on only one network. This also applies for all the other API's such as the Avatar API etc. With unity consciousness the possibilities are limitless!
-
-### Future Prove! Never Need To Learn A New Tech Stack/Language Again
-
-The OASIS API is very intuitive and easy to use hiding away the complexities of the lower-level networks/protocols/platforms/API's but at the same time gives full power and control to power users who wish to dive deeper into the lower-level tech. This also means you do not need to keep learning new tech/APIs/programming languages etc, from now on you only ever need to use the very intuitive powerful OASIS API and the rest is taken care of for you! Also, even if a newer version of one network/API comes out like Holochain RSM or Ethereum 2, you do not need to do anything to port your app to the latest version, the OASIS will take care of this for you. This saves you valuable time to focus on bringing your idea to life! Happy Days! :)
-
-### SEEDS API
-
-The OASIS API also has a SEEDS API allowing people to earn karma for donating and paying with Seeds (a new currency based on re-generating the planet) as well as when they invite or join Seeds. Read more here: <https://joinseeds.earth/>
-
-### Keys/Wallet API
-
-Finally it also features a new powerful Keys/Wallets API, which allows public private keys to be linked to your avatar per provider and private keys are only stored locally. Public keys and the rest of the wallet are stored on any provider (and auto-replicated across providers). Using the Avatar SSO you can also login using any of your public keys linked to your avatar (as well as either your username or email). You can also transfer tokens using any of these 3 so you do not need to ever worry about long meaningless public keys!
-
-All of your wallets, bank accounts, PayPal, etc can be linked to your aggregated OASIS Wallet so you can see your full balance of assets and easily transfer between ANY of them with just one cick, gone are the days of having to painfully manage and transfer between mutiple wallets just to get access to your funds!
+## About The OASIS Omniverse
 
-Because of the auto replication the private keys are automatically backed up to your local devices and can automatically sync between them so if you get a new device it can automatically sync with it, a bit like a decentralised offline cloud.
+The OASIS (Open Advanced Sensory Immersion System) is the universal interoperability layer connecting all of WEB2 and WEB3 — every blockchain, database, cloud provider and protocol — into one unified, fault-tolerant API. Rather than picking a single tech stack, the OASIS harnesses the best of every provider (auto-failover, auto-load-balancing, auto-replication) so nothing is ever a single point of failure, and hides the complexity behind one intuitive API so you never need to learn a new stack again — even as underlying tech evolves (Ethereum 2, Holochain RSM, etc.), your app keeps working with zero changes.
 
-You will never lose your keys again! ;-)
+At its core sits one Avatar with one SSO login and one Karma reputation score that travels with you across every app, game and world built on top of it — full transparency and full control over your own data, right down to the field level.
 
-It can also then sync your public key and wallet address etc when you go back online. With this architecture it opens the doors to many new use cases...
+This is the foundation of the OASIS Omniverse: a network of unified layers, WEB4 (identity & unification) through WEB10 (source), each building on the one below to connect blockchains, metaverses, AI, human consciousness and beyond into a single interoperable whole.
 
-### Works Offline/Local Networks (LAN, Bluetooth, Mesh Networks)
-
-This same technology works across all of the API's (Avatar, Data, etc) so you can work offline if your connection to the internet goes down and will automatically sync once it goes back online. It even allows you to network over LAN, Bluetooth, Mesh Networks, etc.
-
-### OAPPS - Write Once, Deploy Everywhere
-
-OAPP's (OASIS Apps) that use the OASIS API can be deployed anywhere across any network, platform, API or protocol. This includes all of WEB2 (clouds, databases, etc),  Holochain, every popular blockchain, ActivityPub, IPFS, SOLID & many more... check the growing list of providers supported below.
-
-Gone are the days of having to write multiple dApps and having to spend lots of time setting up your dev environment for each one such as the network, wallet, account, etc. The OASIS API can manage all of this for you with one simple to use UI (web, desktop and Unity versions planned). The Unity UI will in fact be Our World and will be the most feature rich through the XR interface.
-
-You can also of course fully manage every feature and option through the API itself so you could even write your own UI to it if you so wished.
-
-### One API To Rule Them All - The GOD Protocol/API
-
-The OASIS API will allow you to connect into everything including e-commerce, trading, security, social networks, blockchains, holochain networks, etc. regardless of where they are running (WEB2 or WEB3/IoT).
-
-### Full Smart Contract Interoperability
-
-Smart Contracts will be supported across any of the supported providers (network/platform/API/protocol), so you only need to write the contract once for your OAPP and then deploy your OAPP once and it will then take care of deploying and running your app/smart contract across all supported providers (network/platform/API/protocol).
-
-### Powerful Pick n Mix & Plug n Play UI Components
-
-Soon you will also have a very powerful intuitive UI allowing anyone to build an OAPP through a simple intuitive to use drag n drop interface plugging together the various components (web, unity, unreal, metaverse & more) you need allowing you to focus on your ideas rather than on how to implement them. This will lower the barrier to entry for non-technical people, the perfect low-code solution!
-
-### WEB/2D/3D/AR/VR/IR/Map/Meta Visusalization
-
-Each OAPP can have a Web, 2D, 3D AR, 3D VR, 3D Map, 3D IR ([Infinite Reality](https://www.ourworldthegame.com/single-post/beyond-xr-is-ir-infinite-reality)), 2D Map & Meta View. You will be able to switch between these at run-time.
-
-### Our World Geo-Location/AR/IR/Map UI (Game Of Games Engine)
-
-[Our World](http://www.ourworldthegame.com) is the first world in the infinite Omniverse (what comes after Metaverse). Our World also acts as the UI to the OASIS API allowing the various OAPP’s to have a 3D object/2D sprite representation on the 3D map of the world. They can then view meta data about the app as well as launch the app from within Our World (phase 1 of The OASIS you see in Ready Player One). Through the OASIS API people have a full geo-location API allowing them to fully control the 3D map, add quests, routes, sub-games, AR hotspots, and so much more. One possible use case would be Smart Cities amongst many more.
-
-[Our World](https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK#our-world-overview) is an exciting immersive next generation 3D XR/IR (Infinite Reality) educational game/platform/social network/ecosystem teaching people on how to look after themselves, each other and the planet using the latest cutting-edge technology. It teaches people the importance of real-life face to face connections with human beings and encourages them to get out into nature using Augmented Reality similar to Pokémon Go but on a much more evolved scale. This is our flagship product and is our top priority due to the massive positive impact it will make upon the world...
-
-It is the XR/IR Gamification layer of the new interplanetary operating system & the new internet (Web 3.0), which is being built by the elite technical wizards stationed around the world. This will one day replace the current tech giants such as Google, FaceBook, etc and act as the technical layer of the New Earth, which is birthing now.  Unlike the current tech giants who's only aim is to ruthlessly maximize profits at the expense of people and the planet (as well as spying, exploitation, censorship & social engineering), our technology is based on true love & unity consciousness where money and profits are not our aim or intention, our aim and intention is to heal the entire planet & human race so we can all live in harmony with each other. It is a 5th dimensional and ascension training platform, teaching people vital life lessons as well as acting as a real-time simulation of the real world.
-
-Our World is built on top of the de-centralised, distributed nextgen internet known as Holochain (but bridges to all other WEB2 & WEB3 sites/apps/games through the OASIS API).
-
-The first phase of Our World will be a de-centralised distributed XR Gamified 3D Map replacement for Google Maps along with the Avatar/Profile/Karma & OASIS API system. The satellite apps/games will be able to create their own 2D/3D object to appear on the real-time 3D map.
-
-[Check out the site](http://www.ourworldthegame.com) for more info.
-
-Read another more refined (and updated) summary on the github repo code base for the Our World Smartphone AR Prototype:<br>
-<https://github.com/NextGenSoftwareUK/Our-World-Smartphone-Prototype-AR>
-
-### IR (Infinite Reality) Ready
-
-IR is what comes after AR, VR & XR. It is where the boundary between real and the virtual become one. More coming soon... ;-)
-
-### One World Open World MMO (VR) (Game Of Games Engine)
-
-One World is Our World's cousin and is a Open World MMORPG set in the past allowing people to build whatever they can imagine unleashing their FULl creativity & potential! It uses bio-feedback technology allowing you to move objects with your mind with real force powers! :) You can also see other players avatar/chakras in real-time and so much more! You can medidate to make it rain to water your crops or to help your camp fire burn brighter!
-
-One World will be the first AAA MMO game and 2D/3D Social Network to run on HoloChain and the Blockchain. It will also be the first to integrate a social network with a MMO game/platform as well as all of these technologies and devices together. As with the rest of the game, it will be leading the way in what can be done with this NextGen Technology for the benefit and upliftment of humanity.
-
-More news on this soon...
-
-### XR/IR Unified Interface To The World
-
-Our World & One World are like the XR/IR Unified Interface into all of these hApps/dAps/Websites/apps/games (this is the Operating System part of it), it's a bit like the XR UI front-end to Holochain/Blockchains/WEB2 where you can view and launch any app/website/game from inside it but they integrate much more deeper than that through the OASIS API/Profile/Avatar/Karma system where they all share the central avatar/profile and can all add/subtract the profiles/avatars karma.
-
-Both One World (desktop/console) & Our World (smartphone) players can interact in real-time through time portals and much more...
-
-### ARC/HoloMap/Synergy Engine Integration
-
-We will be implementing the ARC (Augmented Reality Computer) Membrane allowing the revolutionary next-gen operating system to fully interface & integrate with the 3D Map & Avatar/Karma system as well as render its own 3D interfaces and 2D HUD overlays on top of the map, etc.
-
-We will also port HoloMap (previously called Noomap) to Unity and will implement a Synergy Engine allowing people to easily find and match solutions/desires/passions and to also find various solution providers, which again will be fully integrated with the 3D Map & Avatar/Karma system.
-
-### WEB 5 STAR OASIS Omniverse Interoperable Metaverse Low Code Generator
-
-[The WEB 5 STAR OASIS Omniverse Interoperable Metaverse Low Code Generator](https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK#web5-star-odk) is built on top of the OASIS API and aggregates all the worlds data and expresses it within a cyberspace ontology using a cutting edge custom built ORM (Object Relational Mapper) called COSMIC. The STAR Omniverse is both a simulation & game of life and aggregates all metaverses into one fully integrated unified platform. It is also a fully integrated immersive interoperable metaverse Low Code Generator and soooooo much more.... ;-)
-
-It connects and integrates all metaverses together through the SSO Avatar/Karma system (part of the OASIS API). It is also a fully interoperable Metaverse Low Code Generator (connecting all WEB 2 and WEB 3 together) through the WEB 4 OASIS API.
-
-The STAR ODK, the heart of the OASIS can even compile OAPP's to native code for each platform, provider, network, etc. For example, for Holochain Provider it dynamically generates the low-level Rust code, which acts as the DAL (Data Access Layer). It also dynamically generates the C# code that runs on top of it abstracting away the lower-level complexities and this acts as the BLL (Business Logic Layer). This has the additional benefit that you can now debug your app logic in C#, something you cannot do in rust. It also allows you to have the best of both worlds by giving you access to both rust and C# libraries. The possibilities are endless, time to unleash YOUR full potential!
-
-### AI/Machine Learning Over All Of World's Aggregated Data
-
-Both WEB 4 & WEB 5 use machine learning AI to analyse all of the worlds data to generate useful insights, predictions & so much more!
-
-### Summary
-
-To summarize, WEB4 OASIS API aggregates all of the worlds data into a fully unified API to allow better sense making to made, which then feeds into WEB5 STAR, which expresses it in a cyberspace ontology and connects the worlds data to the rest of the COSMOS and Galaxy... ;-)
+👉 See the full ecosystem at **[oasisomniverse.one](https://oasisomniverse.one)**.
 
 <a name="web4-oasisapi-benefits"></a>
 
 ## Benefits Of Building On The WEB4 OASIS API
 
-- **Integrate any WEB2 or WEB3 tech into your (web)app without having to learn or worry about new tech stacks/languages (the OASIS API hides all the complexity away so you can focus on creating your dream app!).**
-
-- **No need to worry about how different blockchains or WEB2 and WEB3 can talk and integrate with each other, the OASIS handles all this for you!**
-
-- **Future prove so when any new language/tech comes out such as Ethereum2 etc, these will be automatically added to the OASIS API for FREE, you will have FREE upgrades for life!**
-
-- **SSO Avatar.**
-
-- **Karma API (full accountability/zero crime/dark net prove) System.**
-
-- **Maximum Integration & Interoprability.**
-
-- **Auto Load-balancing.**
-
-- **Auto Fail-over.**
-
-- **Auto Replication.**
-
-- **Best Of All Worlds.**
-
-- **Maximum Interopability/Aggregation.**
-
-- **HOT Swapable PlugIn Architecture.**
-
-- **HTTP REST/gRPC/GraphQL/CLI/Native Endpoints.**
-
-- **Javascript, Unity & C# Packages - More Coming...**
-
-- **Write Once, Deploy Everywhere Now & Forever.**
-
-- **One API To Rule Them All - The GOD Protocol/API.**
-
-- **Full Smart Contract Interoperability.**
-
-- **AI/Machine Learning Over All Of World's Aggregated Data.**
-
-- **Triple Level Quantum Resistant Encryption.**
-
-- **Intelligent Key Management/Backups/Redundancy (never lose your keys again!).**
-
-- **Full Redundancy/Zero Downtime/Impossible To Shutdown!**
-
-- **Zero Lag.**
-
-- **Infinite Players Online At Same Time.**
-
-- **Decentralised Distributed P2P Networking.**
-
-- **Can Work Off-line (will automatically sync once online again).**
-
-- **When Offline Can Still Sync And Work Over LAN, Bluetooth, Mesh Networks, etc.**
-
-- **Agent Centric (User owns and stores own data).**
-
-- **WEB/2D/3D/AR/VR/IR/Map/Meta Visusalization.**
-
-- **Our World Geo-Location/AR/IR/Map UI (Game of Games Engine).**
-
-- **One World Open World MMO (VR) UI (Game of Games Engine).**
-
-- **Powerful Pick n Mix & Plug n Play UI Components.**
-
-- **Smart City Ready.**
-
-- **Bio-feedback Ready.**
-
-- **Synergy Engine Ready.**
-
-- **IR (Infinite Reality) Ready.**
-
-- **WEB5 Omniverse/Metaverse Ready.**
-
-- **Plus Much More!**
+- **Integrate any WEB2 or WEB3 tech into your (web)app without having to learn or worry about new tech stacks/languages.**
+- **The OASIS handles all cross-chain/cross-provider integration for you.**
+- **Future prove — new tech (Ethereum2 etc.) gets added for FREE, so you get free upgrades for life.**
+- **SSO Avatar with a Karma reputation system (full accountability, zero crime, dark-net proof).**
+- **Maximum integration & interoperability, auto load-balancing, auto fail-over, auto replication.**
+- **HOT-swappable plugin architecture. HTTP REST/gRPC/GraphQL/CLI/Native endpoints.**
+- **Javascript, Unity & C# packages — more coming.**
+- **Write once, deploy everywhere, now and forever — the GOD Protocol/API.**
+- **Full smart contract interoperability. AI/machine learning over all of the world's aggregated data.**
+- **Triple-level quantum-resistant encryption & intelligent key management (never lose your keys again).**
+- **Full redundancy/zero downtime — impossible to shut down. Zero lag. Infinite players online at once.**
+- **Decentralised distributed P2P networking — works offline and syncs automatically (even over LAN/Bluetooth/Mesh).**
+- **Agent-centric: you own and store your own data.**
+- **Powers WEB/2D/3D/AR/VR/IR/Map/Meta visualization, Our World & One World (Game of Games Engine).**
+- **Smart City ready. Bio-feedback ready. IR (Infinite Reality) ready. WEB5 Omniverse/Metaverse ready.**
 
 Check out more info below:<br><br>
 [The Power Of The OASIS API](https://drive.google.com/file/d/1nnhGpXcprr6kota1Y85HDDKsBfJHN6sn/view?usp=sharing) <br>
 [What Is WEB4 & WEB5 Really?](https://www.ourworldthegame.com/single-post/what-is-web4-web5-really) <br>
-[First Production Release Of The WEB4 OASIS API](https://www.ourworldthegame.com/single-post/first-production-ready-release-of-@oasisomniverse/web4-api-more) <br>
+[First Production Release Of The WEB4 OASIS API](https://www.ourworldthegame.com/single-post/first-production-ready-release-of-web4-oasis-api-more) <br>
 [Annoucing WEB5 STAR ODK/HDK/COSMIC](https://www.ourworldthegame.com/single-post/announcing-star-odk-hdk-cosmic)  <br>
 [STAR ODK/HDK/COSMIC/OASIS API/Our World Update](https://www.ourworldthegame.com/single-post/star-odk-hdk-cosmic-oasis-api-our-world-update) <br>
-[Main WEB4 OASIS API & WEB5 STAR Repo](https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK)
+[Main WEB4 OASIS API & WEB5 STAR Repo](https://github.com/NextGenSoftwareUK/OASIS)
 
 <a name="web4-oasisapi-packages"></a>
 
@@ -359,7 +98,7 @@ Check out more info below:<br><br>
 ### Javascript
 
 <https://www.npmjs.com/package/@oasisomniverse/web4-api> \
-<https://github.com/NextGenSoftwareUK/OASIS-API-Javascipt-Package>
+<https://github.com/NextGenSoftwareUK/OASIS-API-Javascipt-Package-WEB4>
 
 ### Unity
 
@@ -367,9 +106,9 @@ Check out more info below:<br><br>
 
 <a name="csharp"></a>
 
-### C #
+### C#
 
-<https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK>
+<https://github.com/NextGenSoftwareUK/OASIS>
 
 <a name="get-involved"></a>
 
@@ -386,7 +125,7 @@ We also offer FREE training and apprenticeship program with the NextGen Develope
 
 We are looking for Web Devs (with any of these: react, angular, vue, js, html, css), Unity Devs & C# Devs.
 
-If anyone is interested in developing this game/platform, then we would LOVE to hear from you! 😊 There will be opportunities for people to own shares and/or cryptocurrency (as well as other unique perks such as premium locations in both the geolocation and VR versions, personal or business service spotlights, free lifetime access to all premium paid services, massive karma points (allowing your avatar to progress to more advanced stages in the game unlocking new exciting quests, areas to explore & new special abilities/superpowers) plus lots more!) based on the input they are willing to provide.  
+If anyone is interested in developing this game/platform, then we would LOVE to hear from you! 😊 There will be opportunities for people to earn tokens/NFTs (as well as other unique perks such as premium locations in both the geolocation and VR versions, personal or business service spotlights, free lifetime access to all premium paid services, massive karma points (allowing your avatar to progress to more advanced stages in the game unlocking new exciting quests, areas to explore & new special abilities/superpowers) plus lots more!) based on the input they are willing to provide.  
 
 Thank you and we hope we find interest from people to join us on this exciting incredible journey.
 
@@ -396,46 +135,34 @@ Thank you and we hope we find interest from people to join us on this exciting i
 
 **Ready to be a hero?**
 
-If the answer is YES, then please [proceed to here](https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK/wiki/So-You-Want-To-Get-Involved%3F-Ready-To-Be-A-Hero%3F)...
+If the answer is YES, then please [proceed to here](https://github.com/NextGenSoftwareUK/OASIS/wiki/So-You-Want-To-Get-Involved%3F-Ready-To-Be-A-Hero%3F)...
 
 <a href="https://drive.google.com/file/d/1b_G08UTALUg4H3jPlBdElZAFvyRcVKj1/view">Dev Requirements To Join The Our World Tribe</a><br>
 <a href="https://drive.google.com/file/d/12pCk20iLw_uA1yIfojcP6WwvyOT4WRiO/view?usp=sharing">The Our World Mission (Summary)</a><br>
+<http://web4.oasisomniverse.one><br>
+<http://api.web4.oasisomniverse.one><br>
+<http://oportal.oasisomniverse.one><br>
+<https://github.com/NextGenSoftwareUK/OASIS><br>
+<http://oasisomniverse.one><br>
 <http://www.ourworldthegame.com><br>
-<http://oasisplatform.world/swagger><br>
-<https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK><br>
-<http://www.gofundme.com/ourworldthegame><br>
-
-<http://www.nextgensoftware.co.uk><br>
-<http://www.yoga4autism.com><br>
-
-<https://youtu.be/wdYa5wQUfrg><br>
-<https://www.youtube.com/watch?v=2oY4_LZBW4M&t=3s><br>
-<https://www.youtube.com/watch?v=rvNJ6poMduo&t=5s><br>
-<https://www.youtube.com/watch?v=zyVmciqD9rs><br>
-<https://www.youtube.com/watch?v=SB97mvzJiRg&t=3s><br>
+<http://www.nextgenworld.co.uk><br>
 
 **TOGETHER WE CAN CREATE A BETTER WORLD**
 
 In Love, Light & Hope,<br>
 The Our World Tribe
 
-## How To Use
-
-This is **v2.0.0** - a full rewrite. It is isomorphic (works the same in Node.js 18+
-and in the browser), has zero dependencies (uses the global `fetch`), and covers
-every controller on the OASIS2 ONODE WebAPI - not just Avatar/Karma/Data/NFT
-(32 modules, 485 operations).
-
-### Install
+## Install
 
 ```bash
 npm install @oasisomniverse/web4-api
 ```
 
-### Quickstart
+## Quick start
 
 ```js
-const { OASISClient } = require('@oasisomniverse/web4-api'); // or: import { OASISClient } from '@oasisomniverse/web4-api'
+const { OASISClient } = require('@oasisomniverse/web4-api');
+// or: import { OASISClient } from '@oasisomniverse/web4-api';
 
 const oasis = new OASISClient({ baseUrl: 'https://api.oasisweb4.one' });
 
@@ -445,20 +172,175 @@ const { isError, message, session } = await oasis.auth.login({
 });
 if (isError) throw new Error(message);
 
-// Every controller is exposed as oasis.<lowerCamelName> - e.g.:
-const karma = await oasis.karma.getKarmaForAvatar({ avatarId: session.avatarId });
+const { result: karma } = await oasis.karma.getKarmaForAvatar({ avatarId: session.avatarId });
 ```
 
-### Full documentation
+## Calling any endpoint
+
+Every controller on the OASIS ONODE WebAPI is reachable as a lowerCamel
+property on the client (`oasis.avatar`, `oasis.karma`, `oasis.data`,
+`oasis.wallet`, `oasis.nft`, `oasis.holochain`, ...). Every generated method
+takes a single args object:
+
+- Any key matching a `{token}` in the route template is consumed and
+  substituted into the URL (case-insensitive match).
+- Any remaining keys become the query string (GET/DELETE) or JSON body
+  (POST/PUT) - **matching the real `[FromQuery]`/`[FromBody]` binding of the
+  underlying C# action**, not just the HTTP verb. `endpoints.json` records
+  exactly which arg names are query-bound per operation (see
+  [`docs/`](./docs/README.md) for the per-method breakdown).
+- When an action's entire body is a single primitive `[FromBody]` parameter,
+  the JSON body is that value directly - not an object wrapping it.
+
+Every response has the shape:
+
+```ts
+interface OASISResponse<T = any> {
+  isError: boolean;
+  message: string | null;
+  result: T;
+  raw: any;
+  statusCode: number;
+}
+```
+
+## Auth & sessions
+
+`oasis.auth` is a hand-written ergonomic wrapper that manages the SDK's
+`TokenStore` for you so you don't have to think about JWTs.
+
+```js
+const loginRes = await oasis.auth.login({ username: 'me@example.com', password: '...' });
+if (loginRes.isError) throw new Error(loginRes.message);
+
+console.log(oasis.auth.isAuthenticated()); // true
+console.log(oasis.auth.getSession());      // { avatarId, username, email, jwtToken, ... }
+
+await oasis.auth.logout(); // clears the local session
+```
+
+If you already have a JWT (e.g. issued by your own backend), set it directly:
+
+```js
+oasis.setToken(jwtToken, { avatarId, username });
+```
+
+## Module examples
+
+### Avatar (`oasis.avatar`)
+
+```js
+const detail = await oasis.avatar.getAvatarDetail({ id: avatarId });
+await oasis.avatar.update({ id: avatarId, username: 'newname' });
+await oasis.avatar.addKarmaToAvatar({ avatarId, karmaGain: 5, karmaSourceTitle: 'Recycling' });
+```
+
+### Karma (`oasis.karma`)
+
+```js
+const karma = await oasis.karma.getKarmaForAvatar({ avatarId });
+await oasis.karma.removeKarmaFromAvatar({ avatarId, karmaLoss: 10, karmaSourceTitle: 'Litter' });
+```
+
+### Data (`oasis.data`)
+
+```js
+const holon = await oasis.data.loadHolon({ holonId });
+await oasis.data.saveHolon({ /* ...holon fields */ });
+```
+
+### Wallet (`oasis.wallet`)
+
+```js
+const wallets = await oasis.wallet.loadProviderWalletsForAvatarByIdAsync({ id: avatarId });
+await oasis.wallet.sendTokenAsync({ /* ...SendTransactionRequest fields */ });
+await oasis.wallet.transferBetweenWalletsAsync({ /* ...TransferRequest fields */ });
+```
+
+### NFT (`oasis.nft`)
+
+```js
+const nfts = await oasis.nft.loadAllWeb4NFTsForAvatarAsync({ avatarId });
+await oasis.nft.mintNftAsync({ /* ...MintNFTRequest fields */ });
+```
+
+### Holochain (`oasis.holochain`)
+
+```js
+const agentIds = await oasis.holochain.getHolochainAgentIdsForAvatar({ avatarId });
+const balance = await oasis.holochain.getHoloFuelBalanceForAvatar({ avatarId });
+```
+
+## Module reference
+
+32 modules, 483 operations in total. Full per-method tables live in
+[`docs/`](./docs/README.md).
+
+| Client property | Route prefix | Operations |
+| --- | --- | --- |
+| `oasis.avatar` | `api/avatar` | 61 |
+| `oasis.bridge` | `api/v1/bridge` | 7 |
+| `oasis.chat` | `api/chat` | 3 |
+| `oasis.clan` | `api/clan` | 10 |
+| `oasis.competition` | `api/competition` | 9 |
+| `oasis.data` | `api/data` | 10 |
+| `oasis.eOSIO` | `api/eosio` | 9 |
+| `oasis.eggs` | `api/eggs` | 6 |
+| `oasis.files` | `api/files` | 6 |
+| `oasis.gifts` | `api/gifts` | 6 |
+| `oasis.health` | `api/health` | 2 |
+| `oasis.holochain` | `api/holochain` | 7 |
+| `oasis.hyperDrive` | `api/hyperDrive` | 77 |
+| `oasis.karma` | `api/karma` | 12 |
+| `oasis.keys` | `api/keys` | 59 |
+| `oasis.map` | `api/map` | 22 |
+| `oasis.messaging` | `api/messaging` | 6 |
+| `oasis.nft` | `api/nft` | 32 |
+| `oasis.oLand` | `api/oLand` | 7 |
+| `oasis.oNET` | `api/v1/onet` | 11 |
+| `oasis.oNODE` | `api/v1/onode` | 13 |
+| `oasis.provider` | `api/provider` | 31 |
+| `oasis.search` | `api/search` | 1 |
+| `oasis.seeds` | `api/seeds` | 3 |
+| `oasis.settings` | `api/settings` | 13 |
+| `oasis.share` | `api/share` | 1 |
+| `oasis.social` | `api/social` | 4 |
+| `oasis.solana` | `api/solana` | 2 |
+| `oasis.stats` | `api/stats` | 8 |
+| `oasis.subscription` | `api/subscription` | 10 |
+| `oasis.video` | `api/video` | 3 |
+| `oasis.wallet` | `api/wallet` | 32 |
+
+See [`docs/README.md`](./docs/README.md) for the full generated reference,
+or [`docs/modules/`](./docs/modules) for per-module method tables with
+parameter and route details.
+
+## Regenerating
+
+The generated modules, type declarations and docs are produced from
+`endpoints.json` (extracted from the ONODE WebAPI controller source):
+
+```bash
+node scripts/extract-endpoints.js
+node scripts/generate-modules.js   # src/modules/*.js + src/modules/index.js
+node scripts/generate-types.js     # src/modules/*.d.ts + index.d.ts + src/core/types.d.ts
+node scripts/generate-full-docs.js # docs/README.md + docs/modules/*.md
+```
+
+`src/modules/Auth.js` is the one hand-written module (everything else is
+generated) - see [docs/auth.md](./docs/auth.md) for details.
+
+## Testing
+
+```bash
+npm test
+```
+
+## Full documentation
 
 - **[docs/getting-started.md](./docs/getting-started.md)** - install, client options, the calling convention, response shape.
 - **[docs/auth.md](./docs/auth.md)** - login/register/logout, session handling in the browser vs. serverless/Node.
-- **[docs/README.md](./docs/README.md)** - full module reference: every one of the 32 modules / 485 operations, with HTTP verb, route, route params, and an example call for each.
+- **[docs/README.md](./docs/README.md)** - full module reference: every one of the 32 modules / 483 operations, with HTTP verb, route, route params, and an example call for each.
 
 Docs are generated from the actual code (`scripts/generate-docs.js` parses
 `src/modules/*.js`), so they can't drift from what's actually implemented.
-After running `node scripts/generate-modules.js` against an updated
-`endpoints.json`, re-run `node scripts/generate-docs.js` to refresh `docs/`.
-
-`src/modules/Auth.js` is the one hand-written module (everything else is
-generated) - see [docs/auth.md](./docs/auth.md) for details.

package/docs/auth.md

@@ -1,7 +1,7 @@
 # Auth & Sessions
 
 `oasis.auth` is the one hand-written module in this SDK (everything else is
-generated straight from the OASIS2 controller source - see
+generated straight from the OASIS controller source - see
 [Module Reference](./README.md#module-reference)). It wraps the generated
 `oasis.avatar.authenticate` / `register` / `revokeToken` calls and manages
 the session/token for you.

package/docs/getting-started.md

@@ -2,7 +2,7 @@
 
 `@oasisomniverse/web4-api` is an isomorphic client for the WEB4 OASIS API - it runs the
 same way in Node.js 18+ and in the browser, has zero dependencies (it uses the
-global `fetch`), and covers every controller on the OASIS2 ONODE WebAPI.
+global `fetch`), and covers every controller on the OASIS ONODE WebAPI.
 
 ## Install
 
@@ -49,7 +49,7 @@ registration, logout, and how to manage sessions in stateless environments
 
 ## Calling any endpoint
 
-Every controller on the OASIS2 WebAPI is exposed as a lowerCamel property on
+Every controller on the OASIS WebAPI is exposed as a lowerCamel property on
 the client, e.g. `oasis.avatar`, `oasis.data`, `oasis.karma`, `oasis.nft`,
 `oasis.wallet`, `oasis.map`, `oasis.search`, `oasis.hyperDrive`. See the
 [Module Reference](./README.md#module-reference) for the full list (32
@@ -126,4 +126,4 @@ endpoint.
 
 - [Auth & Sessions](./auth.md)
 - [Module Reference](./README.md#module-reference)
-- [Regenerating modules/docs](../README.md#regenerating-module-coverage) when the OASIS2 API changes
+- [Regenerating modules/docs](../README.md#regenerating-module-coverage) when the OASIS API changes

package/docs/modules/Avatar.md

@@ -1,6 +1,6 @@
 # Avatar — `oasis.avatar`
 
-Source controller: [`AvatarController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/AvatarController.cs)
+Source controller: [`AvatarController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/AvatarController.cs)
 Route prefix: `api/avatar`
 61 operation(s).
 
@@ -2427,7 +2427,7 @@ Link's a given telosAccount to the given avatar.
 
 **Request**
 
-Body type: `LinkProviderKeyToAvatar` _(type definition not found in the OASIS2 source - field list unavailable)_
+Body type: `LinkProviderKeyToAvatar` _(type definition not found in the OASIS source - field list unavailable)_
 
 **Response**
 

package/docs/modules/Bridge.md

@@ -1,6 +1,6 @@
 # Bridge — `oasis.bridge`
 
-Source controller: [`BridgeController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/BridgeController.cs)
+Source controller: [`BridgeController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/BridgeController.cs)
 Route prefix: `api/v1/bridge`
 7 operation(s).
 

package/docs/modules/Chat.md

@@ -1,6 +1,6 @@
 # Chat — `oasis.chat`
 
-Source controller: [`ChatController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ChatController.cs)
+Source controller: [`ChatController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ChatController.cs)
 Route prefix: `api/chat`
 3 operation(s).
 

package/docs/modules/Clan.md

@@ -1,6 +1,6 @@
 # Clan — `oasis.clan`
 
-Source controller: [`ClanController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ClanController.cs)
+Source controller: [`ClanController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ClanController.cs)
 Route prefix: `api/clan`
 10 operation(s).
 

package/docs/modules/Competition.md

@@ -1,6 +1,6 @@
 # Competition — `oasis.competition`
 
-Source controller: [`CompetitionController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/CompetitionController.cs)
+Source controller: [`CompetitionController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/CompetitionController.cs)
 Route prefix: `api/competition`
 9 operation(s).
 

package/docs/modules/Data.md

@@ -1,6 +1,6 @@
 # Data — `oasis.data`
 
-Source controller: [`DataController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/DataController.cs)
+Source controller: [`DataController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/DataController.cs)
 Route prefix: `api/data`
 10 operation(s).
 

package/docs/modules/EOSIO.md

@@ -1,6 +1,6 @@
 # EOSIO — `oasis.eOSIO`
 
-Source controller: [`EOSIOController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/EOSIOController.cs)
+Source controller: [`EOSIOController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/EOSIOController.cs)
 Route prefix: `api/eosio`
 9 operation(s).
 

package/docs/modules/Eggs.md

@@ -1,6 +1,6 @@
 # Eggs — `oasis.eggs`
 
-Source controller: [`EggsController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/EggsController.cs)
+Source controller: [`EggsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/EggsController.cs)
 Route prefix: `api/eggs`
 6 operation(s).
 

package/docs/modules/Files.md

@@ -1,6 +1,6 @@
 # Files — `oasis.files`
 
-Source controller: [`FilesController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/FilesController.cs)
+Source controller: [`FilesController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/FilesController.cs)
 Route prefix: `api/files`
 6 operation(s).
 

package/docs/modules/Gifts.md

@@ -1,6 +1,6 @@
 # Gifts — `oasis.gifts`
 
-Source controller: [`GiftsController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/GiftsController.cs)
+Source controller: [`GiftsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/GiftsController.cs)
 Route prefix: `api/gifts`
 6 operation(s).
 

package/docs/modules/Health.md

@@ -1,6 +1,6 @@
 # Health — `oasis.health`
 
-Source controller: [`HealthController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/HealthController.cs)
+Source controller: [`HealthController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/HealthController.cs)
 Route prefix: `api/health`
 2 operation(s).
 

package/docs/modules/Holochain.md

@@ -1,6 +1,6 @@
 # Holochain — `oasis.holochain`
 
-Source controller: [`HolochainController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/HolochainController.cs)
+Source controller: [`HolochainController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/HolochainController.cs)
 Route prefix: `api/holochain`
 7 operation(s).
 

package/docs/modules/HyperDrive.md

@@ -1,6 +1,6 @@
 # HyperDrive — `oasis.hyperDrive`
 
-Source controller: [`HyperDriveController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/HyperDriveController.cs)
+Source controller: [`HyperDriveController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/HyperDriveController.cs)
 Route prefix: `api/hyperDrive`
 77 operation(s).
 

package/docs/modules/Karma.md

@@ -1,6 +1,6 @@
 # Karma — `oasis.karma`
 
-Source controller: [`KarmaController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/KarmaController.cs)
+Source controller: [`KarmaController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/KarmaController.cs)
 Route prefix: `api/karma`
 12 operation(s).
 

package/docs/modules/Keys.md

@@ -1,6 +1,6 @@
 # Keys — `oasis.keys`
 
-Source controller: [`KeysController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/KeysController.cs)
+Source controller: [`KeysController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/KeysController.cs)
 Route prefix: `api/keys`
 59 operation(s).
 
@@ -509,7 +509,7 @@ No request body.
 
 Standard `OASISResult` envelope (see top of this page) with:
 
-`result` type: `IKeyPairAndWallet` _(type definition not found in the OASIS2 source - field list unavailable)_
+`result` type: `IKeyPairAndWallet` _(type definition not found in the OASIS source - field list unavailable)_
 
 **Example**
 
@@ -763,7 +763,7 @@ No request body.
 
 Standard `OASISResult` envelope (see top of this page) with:
 
-`result` type: `IKeyPairAndWallet` _(type definition not found in the OASIS2 source - field list unavailable)_
+`result` type: `IKeyPairAndWallet` _(type definition not found in the OASIS source - field list unavailable)_
 
 **Example**
 
@@ -3176,7 +3176,7 @@ Link's a given telosAccount to the given avatar.
 
 **Request**
 
-Body type: `LinkProviderKeyToAvatar` _(type definition not found in the OASIS2 source - field list unavailable)_
+Body type: `LinkProviderKeyToAvatar` _(type definition not found in the OASIS source - field list unavailable)_
 
 **Response**
 

package/docs/modules/Map.md

@@ -1,6 +1,6 @@
 # Map — `oasis.map`
 
-Source controller: [`MapController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/MapController.cs)
+Source controller: [`MapController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/MapController.cs)
 Route prefix: `api/map`
 22 operation(s).
 

package/docs/modules/Messaging.md

@@ -1,6 +1,6 @@
 # Messaging — `oasis.messaging`
 
-Source controller: [`MessagingController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/MessagingController.cs)
+Source controller: [`MessagingController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/MessagingController.cs)
 Route prefix: `api/messaging`
 6 operation(s).
 

package/docs/modules/Nft.md

@@ -1,6 +1,6 @@
 # Nft — `oasis.nft`
 
-Source controller: [`NftController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/NftController.cs)
+Source controller: [`NftController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/NftController.cs)
 Route prefix: `api/nft`
 32 operation(s).
 

package/docs/modules/OLand.md

@@ -1,6 +1,6 @@
 # OLand — `oasis.oLand`
 
-Source controller: [`OLandController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/OLandController.cs)
+Source controller: [`OLandController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/OLandController.cs)
 Route prefix: `api/oLand`
 7 operation(s).
 

package/docs/modules/ONET.md

@@ -1,6 +1,6 @@
 # ONET — `oasis.oNET`
 
-Source controller: [`ONETController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ONETController.cs)
+Source controller: [`ONETController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ONETController.cs)
 Route prefix: `api/v1/onet`
 11 operation(s).
 

package/docs/modules/ONODE.md

@@ -1,6 +1,6 @@
 # ONODE — `oasis.oNODE`
 
-Source controller: [`ONODEController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ONODEController.cs)
+Source controller: [`ONODEController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ONODEController.cs)
 Route prefix: `api/v1/onode`
 13 operation(s).
 

package/docs/modules/Provider.md

@@ -1,6 +1,6 @@
 # Provider — `oasis.provider`
 
-Source controller: [`ProviderController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ProviderController.cs)
+Source controller: [`ProviderController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ProviderController.cs)
 Route prefix: `api/provider`
 31 operation(s).
 

package/docs/modules/Search.md

@@ -1,6 +1,6 @@
 # Search — `oasis.search`
 
-Source controller: [`SearchController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SearchController.cs)
+Source controller: [`SearchController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SearchController.cs)
 Route prefix: `api/search`
 1 operation(s).
 

package/docs/modules/Seeds.md

@@ -1,6 +1,6 @@
 # Seeds — `oasis.seeds`
 
-Source controller: [`SeedsController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SeedsController.cs)
+Source controller: [`SeedsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SeedsController.cs)
 Route prefix: `api/seeds`
 3 operation(s).
 

package/docs/modules/Settings.md

@@ -1,6 +1,6 @@
 # Settings — `oasis.settings`
 
-Source controller: [`SettingsController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SettingsController.cs)
+Source controller: [`SettingsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SettingsController.cs)
 Route prefix: `api/settings`
 13 operation(s).
 

package/docs/modules/Share.md

@@ -1,6 +1,6 @@
 # Share — `oasis.share`
 
-Source controller: [`ShareController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ShareController.cs)
+Source controller: [`ShareController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/ShareController.cs)
 Route prefix: `api/share`
 1 operation(s).
 

package/docs/modules/Social.md

@@ -1,6 +1,6 @@
 # Social — `oasis.social`
 
-Source controller: [`SocialController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SocialController.cs)
+Source controller: [`SocialController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SocialController.cs)
 Route prefix: `api/social`
 4 operation(s).
 

package/docs/modules/Solana.md

@@ -1,6 +1,6 @@
 # Solana — `oasis.solana`
 
-Source controller: [`SolanaController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SolanaController.cs)
+Source controller: [`SolanaController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SolanaController.cs)
 Route prefix: `api/solana`
 2 operation(s).
 

package/docs/modules/Stats.md

@@ -1,6 +1,6 @@
 # Stats — `oasis.stats`
 
-Source controller: [`StatsController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/StatsController.cs)
+Source controller: [`StatsController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/StatsController.cs)
 Route prefix: `api/stats`
 8 operation(s).
 

package/docs/modules/Subscription.md

@@ -1,6 +1,6 @@
 # Subscription — `oasis.subscription`
 
-Source controller: [`SubscriptionController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SubscriptionController.cs)
+Source controller: [`SubscriptionController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/SubscriptionController.cs)
 Route prefix: `api/subscription`
 10 operation(s).
 

package/docs/modules/Video.md

@@ -1,6 +1,6 @@
 # Video — `oasis.video`
 
-Source controller: [`VideoController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/VideoController.cs)
+Source controller: [`VideoController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/VideoController.cs)
 Route prefix: `api/video`
 3 operation(s).
 

package/docs/modules/Wallet.md

@@ -1,6 +1,6 @@
 # Wallet — `oasis.wallet`
 
-Source controller: [`WalletController.cs`](https://github.com/NextGenSoftwareUK/OASIS2/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/WalletController.cs)
+Source controller: [`WalletController.cs`](https://github.com/NextGenSoftwareUK/OASIS/blob/main/ONODE/NextGenSoftware.OASIS.API.ONODE.WebAPI/Controllers/WalletController.cs)
 Route prefix: `api/wallet`
 32 operation(s).
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@oasisomniverse/web4-api",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "publishConfig": { "access": "public" },
-  "description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB4 OASIS API - full coverage of the OASIS2 ONODE WebAPI (Avatar, Data, Karma, NFT, Wallet, Map, Search, HyperDrive, and more).",
+  "description": "Isomorphic (Node + browser) JavaScript/TypeScript-friendly client for the WEB4 OASIS API - full coverage of the OASIS ONODE WebAPI (Avatar, Data, Karma, NFT, Wallet, Map, Search, HyperDrive, and more).",
   "main": "index.js",
   "module": "index.mjs",
   "types": "index.d.ts",
@@ -33,7 +33,7 @@
     "type": "git",
     "url": "https://github.com/NextGenSoftwareUK/OASIS-API-Javascipt-Package.git"
   },
-  "homepage": "https://github.com/NextGenSoftwareUK/Our-World-OASIS-API-HoloNET-HoloUnity-And-.NET-HDK#readme",
+  "homepage": "https://github.com/NextGenSoftwareUK/OASIS#readme",
   "author": "NextGen Software Ltd",
   "license": "MIT",
   "keywords": [

package/src/index.js

@@ -13,7 +13,7 @@ const { AuthModule } = require('./modules/Auth');
  *   await oasis.auth.login({ username: 'me@example.com', password: '...' });
  *   const karma = await oasis.karma.getKarmaForAvatar({ avatarId: oasis.auth.getSession().avatarId });
  *
- * Every controller on the OASIS2 ONODE WebAPI is reachable as a lowerCamel
+ * Every controller on the OASIS ONODE WebAPI is reachable as a lowerCamel
  * property (oasis.avatar, oasis.data, oasis.karma, oasis.nft, oasis.wallet,
  * oasis.hyperDrive, oasis.map, oasis.search, ...). Generated methods take a
  * single args object; route template tokens (e.g. {id}) are consumed from it