WEB5 JS SDK
@oasisomniverse/web5-api extends WEB4 with Celestial Spaces, GeoNFTs, holonic memory, and Web6/FAHRN agent capabilities. All WEB4 modules are included — install WEB5 instead of WEB4 for access to both.
Installation
terminal
npm install @oasisomniverse/web5-api
WEB5 includes all WEB4 modules
You do not need to install both packages. @oasisomniverse/web5-api re-exports everything from @oasisomniverse/web4-api. Initialise identically — the extra modules are available on the same oasis instance.
Celestial Bodies — oasis.celestialBodies
- celestialBodies.getSolarSystem()Full Our World solar system data with all planets and moons.
- celestialBodies.getPlanet(id)Single planet detail.
- celestialBodies.getMoon(id)Single moon detail.
- celestialBodies.saveCelestialBody(body)Persist a celestial body. Admin / OApp developer only.
Celestial Spaces — oasis.celestialSpaces
- celestialSpaces.getAll()All registered spatial regions.
- celestialSpaces.get(id)Single space by ID.
- celestialSpaces.save(space)Create or update a celestial space.
- celestialSpaces.getAvatarsInSpace(spaceId)All avatars currently in the given space.
GeoNFTs — oasis.geoNFTs
- geoNFTs.getAll()All geolocated NFTs in the world.
- geoNFTs.getNear(lat, lng, radiusKm)GeoNFTs within a radius of a GPS coordinate.
- geoNFTs.mint(params)Mint a new GeoNFT at a latitude/longitude.
- geoNFTs.claim(id, avatarId)Avatar claims a GeoNFT (proximity check enforced server-side).
Holonic Memory — oasis.holonicMemory
- holonicMemory.remember(key, value, avatarId)Store a named memory for an avatar — persists across sessions and devices.
- holonicMemory.recall(key, avatarId)Retrieve a stored memory by key.
- holonicMemory.forget(key, avatarId)Delete a memory.
- holonicMemory.recallAll(avatarId)All memories for an avatar.
Cosmic Layer — oasis.cosmic
The cosmic layer provides access to the macro-scale OASIS universe — galactic structures, star clusters, and deep-space zones beyond the solar system.
- cosmic.getGalaxy(id)Galaxy structure and child star systems.
- cosmic.getSuperCluster(id)Super-cluster of galaxies.
- cosmic.getMultiverse()The full OASIS multiverse map.