@shipload/sdk 1.0.0-next.43 → 1.0.0-next.44

package/src/nft/buildImmutableData.ts

@@ -198,16 +198,14 @@ export function buildModuleImmutable(
         }
         case MODULE_GATHERER: {
             const str = decodeStat(stats, 0)
-            const tol = decodeStat(stats, 1)
-            const con = decodeStat(stats, 2)
-            const ref = decodeStat(stats, 3)
+            const hrd = decodeStat(stats, 1)
+            const sat = decodeStat(stats, 2)
             base.push({first: 'strength', second: ['uint16', str]})
-            base.push({first: 'tolerance', second: ['uint16', tol]})
-            base.push({first: 'saturation', second: ['uint16', con]})
-            base.push({first: 'plasticity', second: ['uint16', ref]})
+            base.push({first: 'hardness', second: ['uint16', hrd]})
+            base.push({first: 'saturation', second: ['uint16', sat]})
             base.push({first: 'yield', second: ['uint16', computeGathererYield(str)]})
-            base.push({first: 'drain', second: ['uint16', computeGathererDrain(con)]})
-            base.push({first: 'depth', second: ['uint16', computeGathererDepth(tol, item.tier)]})
+            base.push({first: 'drain', second: ['uint16', computeGathererDrain(sat)]})
+            base.push({first: 'depth', second: ['uint16', computeGathererDepth(hrd, item.tier)]})
             break
         }
         case MODULE_LOADER: {
@@ -220,17 +218,17 @@ export function buildModuleImmutable(
             break
         }
         case MODULE_WARP: {
-            const res = decodeStat(stats, 0)
-            base.push({first: 'resonance', second: ['uint16', res]})
-            base.push({first: 'range', second: ['uint32', computeWarpRange(res)]})
+            const ref = decodeStat(stats, 0)
+            base.push({first: 'reflectivity', second: ['uint16', ref]})
+            base.push({first: 'range', second: ['uint32', computeWarpRange(ref)]})
             break
         }
         case MODULE_CRAFTER: {
-            const rea = decodeStat(stats, 0)
+            const fin = decodeStat(stats, 0)
             const con = decodeStat(stats, 1)
-            base.push({first: 'reactivity', second: ['uint16', rea]})
+            base.push({first: 'fineness', second: ['uint16', fin]})
             base.push({first: 'conductivity', second: ['uint16', con]})
-            base.push({first: 'speed', second: ['uint16', computeCrafterSpeed(rea)]})
+            base.push({first: 'speed', second: ['uint16', computeCrafterSpeed(fin)]})
             base.push({first: 'drain', second: ['uint16', computeCrafterDrain(con)]})
             break
         }
@@ -267,13 +265,13 @@ export function buildModuleImmutable(
         case MODULE_HAULER: {
             const res = decodeStat(stats, 0)
             const pla = decodeStat(stats, 1)
-            const ref = decodeStat(stats, 2)
+            const con = decodeStat(stats, 2)
             base.push({first: 'resonance', second: ['uint16', res]})
             base.push({first: 'plasticity', second: ['uint16', pla]})
-            base.push({first: 'reflectivity', second: ['uint16', ref]})
+            base.push({first: 'conductivity', second: ['uint16', con]})
             base.push({first: 'capacity', second: ['uint8', computeHaulerCapacity(res)]})
             base.push({first: 'efficiency', second: ['uint16', computeHaulerEfficiency(pla)]})
-            base.push({first: 'drain', second: ['uint16', computeHaulerDrain(ref)]})
+            base.push({first: 'drain', second: ['uint16', computeHaulerDrain(con)]})
             break
         }
     }

package/src/nft/description.ts

@@ -107,7 +107,7 @@ export function entityDisplayName(itemId: number): string {
         case ITEM_WAREHOUSE_T1_PACKED:
             return 'Warehouse'
         case ITEM_EXTRACTOR_T1_PACKED:
-            return 'Extractor'
+            return 'Mining Rig'
         case ITEM_FACTORY_T1_PACKED:
             return 'Factory'
         case ITEM_CONTAINER_T1_PACKED:
@@ -124,19 +124,19 @@ export function moduleDisplayName(itemId: number): string {
         case ITEM_ENGINE_T1:
             return 'Engine'
         case ITEM_GENERATOR_T1:
-            return 'Generator'
+            return 'Reactor'
         case ITEM_GATHERER_T1:
-            return 'Gatherer'
+            return 'Limpet Bay'
         case ITEM_LOADER_T1:
-            return 'Loader'
+            return 'Shuttle Bay'
         case ITEM_CRAFTER_T1:
-            return 'Crafter'
+            return 'Fabricator'
         case ITEM_STORAGE_T1:
-            return 'Cargo Bay'
+            return 'Cargo Hold'
         case ITEM_HAULER_T1:
-            return 'Hauler'
+            return 'Tractor Beam'
         case ITEM_WARP_T1:
-            return 'Warp'
+            return 'Warp Drive'
         case ITEM_BATTERY_T1:
             return 'Battery Bank'
         default:

package/src/resolution/describe-module.ts

@@ -61,8 +61,8 @@ const TEMPLATES: Record<string, TemplateSpec> = {
         ],
         highlightKeys: ['yield', 'depth', 'drain'],
     },
-    loader: {
-        id: 'module.loader.description',
+    loading: {
+        id: 'module.loading.description',
         template: 'generates {thrust} thrust with a weight of {mass} per unit',
         params: [
             ['thrust', 'Thrust'],
@@ -70,8 +70,8 @@ const TEMPLATES: Record<string, TemplateSpec> = {
         ],
         highlightKeys: ['thrust', 'mass'],
     },
-    crafter: {
-        id: 'module.crafter.description',
+    crafting: {
+        id: 'module.crafting.description',
         template: 'manufactures items at {speed} speed while draining {drain} energy per second',
         params: [
             ['speed', 'Speed'],
@@ -91,8 +91,8 @@ const TEMPLATES: Record<string, TemplateSpec> = {
         params: [['capacity', 'Energy Capacity']],
         highlightKeys: ['capacity'],
     },
-    hauler: {
-        id: 'module.hauler.description',
+    hauling: {
+        id: 'module.hauling.description',
         template:
             'locks onto up to {capacity} targets at {efficiency} efficiency while draining {drain} energy per distance travelled per target',
         params: [

package/src/resolution/resolve-item.ts

@@ -198,7 +198,7 @@ function computeCapabilityGroup(
         case MODULE_LOADER: {
             const caps = computeLoaderCapabilities(stats)
             return {
-                capability: 'Loader',
+                capability: 'Loading',
                 attributes: [
                     {label: 'Mass', value: caps.mass},
                     {label: 'Thrust', value: caps.thrust},
@@ -209,7 +209,7 @@ function computeCapabilityGroup(
         case MODULE_CRAFTER: {
             const caps = computeCrafterCapabilities(stats)
             return {
-                capability: 'Crafter',
+                capability: 'Crafting',
                 attributes: [
                     {label: 'Speed', value: caps.speed},
                     {label: 'Drain', value: caps.drain},
@@ -219,7 +219,7 @@ function computeCapabilityGroup(
         case MODULE_HAULER: {
             const caps = computeHaulerCapabilities(stats)
             return {
-                capability: 'Hauler',
+                capability: 'Hauling',
                 attributes: [
                     {label: 'Capacity', value: caps.capacity},
                     {label: 'Efficiency', value: caps.efficiency},

package/src/shipload.ts

@@ -10,6 +10,7 @@ import type {LocationsManager} from './managers/locations'
 import type {CoordinatesManager} from './managers/coordinates'
 import type {EpochsManager} from './managers/epochs'
 import type {ActionsManager} from './managers/actions'
+import type {ClusterManager} from './managers/cluster'
 import type {NftManager} from './managers/nft'
 import type {SubscriptionsManager} from './subscriptions/manager'
 import type {GameState} from './entities/gamestate'
@@ -123,6 +124,10 @@ export class Shipload {
         return this._context.actions
     }
 
+    get clusters(): ClusterManager {
+        return this._context.clusters
+    }
+
     get nft(): NftManager {
         return this._context.nft
     }

package/src/subscriptions/manager.cluster.test.ts

@@ -0,0 +1,46 @@
+import {afterEach, describe, expect, test} from 'bun:test'
+import {SubscriptionsManager} from './manager'
+import type {ServerMessage} from './types'
+
+function createManager(): SubscriptionsManager {
+    return new SubscriptionsManager({url: 'ws://localhost:0'})
+}
+
+function deliver(mgr: SubscriptionsManager, msg: ServerMessage) {
+    ;(mgr as unknown as {onMessage(m: ServerMessage): void}).onMessage(msg)
+}
+
+describe('cluster delta routing', () => {
+    let mgr: SubscriptionsManager | undefined
+
+    afterEach(() => {
+        mgr?.close()
+        mgr = undefined
+    })
+
+    test('routes a cluster frame to the matching entity subscription onCluster', () => {
+        mgr = createManager()
+        const received: unknown[] = []
+        const handle = mgr.subscribeEntity(42, {
+            onCluster: (p) => received.push(p),
+        })
+        deliver(mgr, {
+            type: 'cluster',
+            sub_id: handle.subId,
+            hub_id: 42,
+            seq: 7,
+            cells: [{gx: 0, gy: 1, entity: 99}],
+        })
+        expect(received).toEqual([
+            {hubId: 42, seq: 7, cells: [{gx: 0, gy: 1, entity: 99}], erased: false},
+        ])
+    })
+
+    test('an erased cluster frame yields cells:null, erased:true', () => {
+        mgr = createManager()
+        const received: unknown[] = []
+        const handle = mgr.subscribeEntity(42, {onCluster: (p) => received.push(p)})
+        deliver(mgr, {type: 'cluster', sub_id: handle.subId, hub_id: 42, seq: 8, erased: true})
+        expect(received).toEqual([{hubId: 42, seq: 8, cells: null, erased: true}])
+    })
+})

package/src/subscriptions/manager.ts

@@ -3,6 +3,8 @@ import type {
     BoundingBox,
     BoundsDeltaMessage,
     ClientMessage,
+    ClusterCellWire,
+    ClusterDeltaMessage,
     EntityDeletedMessage,
     ServerMessage,
     SnapshotMessage,
@@ -57,6 +59,12 @@ export interface EntitySubscriptionHandlers {
     ) => void
     onDeleted?: (id: string, meta: EntitySubscriptionMeta) => void
     onError?: (error: Error) => void
+    onCluster?: (payload: {
+        hubId: number
+        seq: number
+        cells: ClusterCellWire[] | null
+        erased: boolean
+    }) => void
 }
 
 export interface EntitiesSubscriptionHandle {
@@ -306,6 +314,9 @@ export class SubscriptionsManager {
             case 'entity_deleted':
                 this.handleEntityDeleted(msg)
                 break
+            case 'cluster':
+                this.handleCluster(msg)
+                break
             case 'error':
                 this.handleError(msg)
                 break
@@ -367,4 +378,15 @@ export class SubscriptionsManager {
         }
         sub.handlers.onDeleted?.(String(msg.entity_id), {seq: msg.seq})
     }
+
+    private handleCluster(msg: ClusterDeltaMessage) {
+        const sub = this.entitySubs.get(msg.sub_id)
+        if (!sub) return
+        sub.handlers.onCluster?.({
+            hubId: msg.hub_id,
+            seq: msg.seq,
+            cells: msg.erased ? null : (msg.cells ?? []),
+            erased: msg.erased === true,
+        })
+    }
 }

package/src/subscriptions/types.ts

@@ -139,6 +139,21 @@ export type ErrorMessage = {
     sub_id?: string
 }
 
+export interface ClusterCellWire {
+    gx: number
+    gy: number
+    entity: number
+}
+
+export type ClusterDeltaMessage = {
+    type: 'cluster'
+    sub_id: string
+    hub_id: number
+    seq: number
+    cells?: ClusterCellWire[]
+    erased?: boolean
+}
+
 export type ServerMessage =
     | AckMessage
     | SnapshotMessage
@@ -149,3 +164,4 @@ export type ServerMessage =
     | EventCatchupCompleteMessage
     | PongMessage
     | ErrorMessage
+    | ClusterDeltaMessage

package/src/types.ts

@@ -5,6 +5,7 @@ import {
     type UInt32,
     type UInt32Type,
     UInt64,
+    type UInt64Type,
 } from '@wharfkit/antelope'
 import {ServerContract} from './contracts'
 
@@ -25,6 +26,12 @@ export const BASE_ORBITAL_MASS = 100000
 export const MIN_TRANSFER_DISTANCE_PLANETARY_STRUCTURE = 100
 export const MIN_TRANSFER_DISTANCE_ORBITAL_VESSEL = 200
 
+export interface ClusterSlotType {
+    hub: UInt64Type
+    gx: number
+    gy: number
+}
+
 export interface ShipLike {
     coordinates: ServerContract.Types.coordinates
     hullmass?: UInt32