@shipload/sdk 1.0.0-next.10 → 1.0.0-next.12

package/src/scheduling/projection.ts

@@ -14,7 +14,7 @@ import {
     RECIPE_INPUTS_INSUFFICIENT,
     RECIPE_INPUTS_INVALID,
     RECIPE_NOT_FOUND,
-    SHIP_CARGO_NOT_LOADED,
+    ENTITY_CARGO_NOT_LOADED,
 } from '../errors'
 import {getRecipe, type RecipeInput} from '../data/recipes-runtime'
 import {getItem} from '../data/catalog'
@@ -389,7 +389,7 @@ function validateCraftTask(task: ServerContract.Types.task, projected: Projected
                 break
             }
         }
-        if (!found) throw new Error(SHIP_CARGO_NOT_LOADED)
+        if (!found) throw new Error(ENTITY_CARGO_NOT_LOADED)
     }
 }
 

package/src/subscriptions/manager.ts

@@ -13,12 +13,10 @@ import type {
     WireEntity,
 } from './types'
 import {mapEntity, parseWireEntity} from './mappers'
-import type {Ship} from '../entities/ship'
-import type {Warehouse} from '../entities/warehouse'
-import type {Container} from '../entities/container'
+import type {Entity} from '../entities/entity'
 
-export type SubscriptionEntityType = 'ship' | 'warehouse' | 'container'
-export type EntityInstance = Ship | Warehouse | Container
+export type SubscriptionEntityType = 'ship' | 'warehouse' | 'container' | 'nexus'
+export type EntityInstance = Entity
 
 export interface SubscriptionsOptions {
     url: string

package/src/subscriptions/mappers.ts

@@ -1,14 +1,9 @@
 import {ServerContract} from '../contracts'
-import {Ship} from '../entities/ship'
-import {Warehouse} from '../entities/warehouse'
-import {Container} from '../entities/container'
+import {Entity} from '../entities/entity'
 import type {WireEntity} from './types'
 
-export function mapEntity(ei: ServerContract.Types.entity_info): Ship | Warehouse | Container {
-    if (ei.type.equals('ship')) return new Ship(ei)
-    if (ei.type.equals('warehouse')) return new Warehouse(ei)
-    if (ei.type.equals('container')) return new Container(ei)
-    throw new Error(`mapEntity: unknown entity type ${ei.type.toString()}`)
+export function mapEntity(ei: ServerContract.Types.entity_info): Entity {
+    return new Entity(ei)
 }
 
 export function parseWireEntity(raw: WireEntity): ServerContract.Types.entity_info {

package/src/subscriptions/types.ts

@@ -39,7 +39,7 @@ export type UnsubscribeMessage = {
 export type SubscribeEntityMessage = {
     type: 'subscribe_entity'
     sub_id: string
-    entity_type: 'ship' | 'warehouse' | 'container'
+    entity_type: 'ship' | 'warehouse' | 'container' | 'nexus'
     entity_id: string
 }
 
@@ -80,7 +80,7 @@ export type AckMessage = {
 
 export type WireEntity = Record<string, unknown> & {
     type: number
-    type_name: 'ship' | 'warehouse' | 'container'
+    type_name: 'ship' | 'warehouse' | 'container' | 'nexus'
     id: string | number
     owner: string
     coordinates: WireCoordinates

package/src/testing/catalog-hash.ts

@@ -0,0 +1,19 @@
+import {createHash} from 'node:crypto'
+import {readFileSync} from 'node:fs'
+
+export const CATALOG_FILES_REL = [
+    'items.json',
+    'recipes.json',
+    'entities.json',
+    'kind-registry.json',
+    'item-ids.ts',
+] as const
+
+export function computeCatalogHash(filePaths: ReadonlyArray<string>): string {
+    const hash = createHash('sha256')
+    for (const p of filePaths) {
+        hash.update(readFileSync(p))
+        hash.update('\0')
+    }
+    return hash.digest('hex')
+}

package/src/testing/index.ts

@@ -0,0 +1,2 @@
+export * from './catalog-hash'
+export * from './projection-parity'

package/src/testing/projection-parity.ts

@@ -0,0 +1,143 @@
+import type {UInt16, UInt32} from '@wharfkit/antelope'
+import type {ServerContract} from '../contracts'
+import type {ProjectedEntity} from '../scheduling/projection'
+import {type CargoStack, cargoItemToStack, mergeStacks} from '../capabilities/storage'
+
+export interface ContractProjectedState {
+    owner: {toString(): string}
+    coordinates: ServerContract.Types.coordinates
+    energy?: UInt16
+    cargomass: UInt32
+    cargo: ServerContract.Types.cargo_view[]
+    hullmass?: UInt32
+    capacity?: UInt32
+    engines?: ServerContract.Types.movement_stats
+    loaders?: ServerContract.Types.loader_stats
+    generator?: ServerContract.Types.energy_stats
+    hauler?: ServerContract.Types.hauler_stats
+}
+
+export interface ProjectionComparisonOptions {
+    step?: number
+}
+
+export function assertProjectionEquals(
+    contract: ContractProjectedState,
+    sdk: ProjectedEntity,
+    options: ProjectionComparisonOptions = {}
+): void {
+    const mismatches: string[] = []
+
+    const record = (name: string, c: unknown, s: unknown) => {
+        if (c !== s) mismatches.push(`  ${name}: contract=${fmt(c)} sdk=${fmt(s)}`)
+    }
+
+    const recordStatBlock = (name: string, c: unknown, s: unknown) => {
+        const cPresent = c !== undefined && c !== null
+        const sPresent = s !== undefined && s !== null
+        if (cPresent !== sPresent) {
+            mismatches.push(
+                `  ${name}: contract=${cPresent ? 'present' : 'absent'} sdk=${sPresent ? 'present' : 'absent'}`
+            )
+            return
+        }
+        if (!cPresent) return
+        const cn = JSON.stringify(normaliseStatBlock(c))
+        const sn = JSON.stringify(normaliseStatBlock(s))
+        if (cn !== sn) mismatches.push(`  ${name}: contract=${cn} sdk=${sn}`)
+    }
+
+    record('coordinates.x', toNum(contract.coordinates.x), Number(sdk.location.x))
+    record('coordinates.y', toNum(contract.coordinates.y), Number(sdk.location.y))
+    record('energy', toNum(contract.energy), Number(sdk.energy))
+    record('cargomass', toNum(contract.cargomass), Number(sdk.cargoMass))
+    record('hullmass', toNum(contract.hullmass), Number(sdk.shipMass))
+    record('capacity', toNum(contract.capacity), sdk.capacity ? Number(sdk.capacity) : undefined)
+
+    recordStatBlock('engines', contract.engines, sdk.engines)
+    recordStatBlock('loaders', contract.loaders, sdk.loaders)
+    recordStatBlock('generator', contract.generator, sdk.generator)
+    recordStatBlock('hauler', contract.hauler, sdk.hauler)
+
+    if (contract.cargo.length > 0 || sdk.cargo.length > 0) {
+        const contractCargo = normaliseCargo(mergeContractCargo(contract.cargo))
+        const sdkCargo = normaliseCargo(sdk.cargo)
+        if (contractCargo.length !== sdkCargo.length) {
+            mismatches.push(
+                `  cargo.length: contract=${contractCargo.length} sdk=${sdkCargo.length}`
+            )
+        } else {
+            for (let i = 0; i < contractCargo.length; i++) {
+                const c = contractCargo[i]
+                const s = sdkCargo[i]
+                if (c.itemId !== s.itemId || c.stats !== s.stats || c.quantity !== s.quantity) {
+                    mismatches.push(
+                        `  cargo[${i}]: contract={item:${c.itemId},stats:${c.stats},qty:${c.quantity}} sdk={item:${s.itemId},stats:${s.stats},qty:${s.quantity}}`
+                    )
+                }
+            }
+        }
+    }
+
+    if (mismatches.length > 0) {
+        const header =
+            options.step !== undefined
+                ? `projection divergence at step ${options.step}:`
+                : 'projection divergence:'
+        throw new Error([header, ...mismatches].join('\n'))
+    }
+}
+
+interface NormalisedStack {
+    itemId: number
+    stats: string
+    quantity: string
+}
+
+function mergeContractCargo(cargo: ServerContract.Types.cargo_view[]): CargoStack[] {
+    return cargo.reduce<CargoStack[]>(
+        (acc, row) =>
+            mergeStacks(acc, cargoItemToStack(row as unknown as ServerContract.Types.cargo_item)),
+        []
+    )
+}
+
+function normaliseCargo(cargo: CargoStack[]): NormalisedStack[] {
+    return cargo
+        .map((s) => ({
+            itemId: Number(s.item_id),
+            stats: BigInt(s.stats.toString()).toString(),
+            quantity: BigInt(s.quantity.toString()).toString(),
+        }))
+        .sort(stackSort)
+}
+
+function stackSort(a: NormalisedStack, b: NormalisedStack): number {
+    if (a.itemId !== b.itemId) return a.itemId - b.itemId
+    return a.stats < b.stats ? -1 : a.stats > b.stats ? 1 : 0
+}
+
+function toNum(v: unknown): number | undefined {
+    if (v === undefined || v === null) return undefined
+    if (typeof v === 'number') return v
+    if (typeof v === 'bigint') return Number(v)
+    if (typeof (v as {toNumber?: unknown}).toNumber === 'function') {
+        return (v as {toNumber(): number}).toNumber()
+    }
+    return Number(v as number)
+}
+
+function fmt(v: unknown): string {
+    if (v === undefined) return 'undefined'
+    if (v === null) return 'null'
+    return String(v)
+}
+
+function normaliseStatBlock(block: unknown): Record<string, number> {
+    const out: Record<string, number> = {}
+    const obj = block as Record<string, unknown>
+    for (const k of Object.keys(obj).sort()) {
+        out[k] = toNum(obj[k]) ?? 0
+    }
+    return out
+}

package/src/types/index.ts

@@ -1,3 +1,2 @@
 export * from './capabilities'
 export * from './entity'
-export * from './entity-traits'

package/src/types.ts

@@ -1,6 +1,5 @@
 import {
     type Int64Type,
-    Name,
     type UInt16,
     type UInt16Type,
     type UInt32,
@@ -72,14 +71,6 @@ export enum TaskCancelable {
     ALWAYS = 2,
 }
 
-export const EntityType = {
-    SHIP: Name.from('ship'),
-    WAREHOUSE: Name.from('warehouse'),
-    CONTAINER: Name.from('container'),
-} as const
-
-export type EntityTypeName = (typeof EntityType)[keyof typeof EntityType]
-
 export type CoordinatesType =
     | Coordinates
     | ServerContract.Types.coordinates

package/src/entities/container.ts

@@ -1,123 +0,0 @@
-import {UInt64, type UInt64Type} from '@wharfkit/antelope'
-import {ServerContract} from '../contracts'
-import type {CoordinatesType} from '../types'
-import {type FloatPosition, getInterpolatedPosition} from '../travel/travel'
-import {Location} from './location'
-import {ScheduleAccessor} from '../scheduling/accessor'
-import * as schedule from '../scheduling/schedule'
-
-export interface ContainerStateInput {
-    id: UInt64Type
-    owner: string
-    name: string
-    coordinates: CoordinatesType | {x: number; y: number; z?: number}
-    hullmass: number
-    capacity: number
-    cargomass?: number
-    cargo?: ServerContract.Types.cargo_item[]
-    schedule?: ServerContract.Types.schedule
-}
-
-export class Container extends ServerContract.Types.entity_info {
-    private _sched?: ScheduleAccessor
-
-    get name(): string {
-        return this.entity_name
-    }
-
-    get entityClass(): 'mobile' {
-        return 'mobile'
-    }
-
-    get canUndeploy(): boolean {
-        return true
-    }
-
-    get sched(): ScheduleAccessor {
-        this._sched ??= new ScheduleAccessor(this)
-        return this._sched
-    }
-
-    get isIdle(): boolean {
-        return this.is_idle
-    }
-
-    interpolatedPositionAt(now: Date): FloatPosition {
-        const taskIndex = this.sched.currentTaskIndex(now)
-        const progress = this.sched.currentTaskProgressFloat(now)
-        return getInterpolatedPosition(this, taskIndex, progress)
-    }
-
-    isLoading(now: Date): boolean {
-        return schedule.isLoading(this, now)
-    }
-
-    isUnloading(now: Date): boolean {
-        return schedule.isUnloading(this, now)
-    }
-
-    get location(): Location {
-        return Location.from(this.coordinates)
-    }
-
-    get totalMass(): UInt64 {
-        return UInt64.from(this.hullmass ?? 0).adding(this.cargomass)
-    }
-
-    get maxCapacity(): UInt64 {
-        return UInt64.from(this.capacity)
-    }
-
-    get availableCapacity(): UInt64 {
-        const cargo = UInt64.from(this.cargomass)
-        return cargo.gte(this.maxCapacity) ? UInt64.from(0) : this.maxCapacity.subtracting(cargo)
-    }
-
-    hasSpace(additionalMass: UInt64): boolean {
-        return UInt64.from(this.cargomass).adding(additionalMass).lte(this.maxCapacity)
-    }
-
-    get isFull(): boolean {
-        return UInt64.from(this.cargomass).gte(this.maxCapacity)
-    }
-
-    get orbitalAltitude(): number {
-        return this.coordinates.z?.toNumber() || 0
-    }
-}
-
-export function computeContainerCapabilities(stats: Record<string, number>): {
-    hullmass: number
-    capacity: number
-} {
-    const density = stats.density
-    const strength = stats.strength
-    const hardness = stats.hardness
-    const saturation = stats.saturation
-
-    const hullmass = 100000 - 75 * density
-
-    const statSum = strength + hardness + saturation
-    const exponent = statSum / 2997
-    const capacity = Math.floor(1000000 * 10 ** exponent)
-
-    return {hullmass, capacity}
-}
-
-export function computeContainerT2Capabilities(stats: Record<string, number>): {
-    hullmass: number
-    capacity: number
-} {
-    const strength = stats.strength
-    const density = stats.density
-    const hardness = stats.hardness
-    const saturation = stats.saturation
-
-    const hullmass = 70000 - 50 * density
-
-    const statSum = strength + hardness + saturation
-    const exponent = statSum / 2500
-    const capacity = Math.floor(1500000 * 10 ** exponent)
-
-    return {hullmass, capacity}
-}

package/src/entities/extractor.ts

@@ -1,144 +0,0 @@
-import {UInt64, type UInt64Type} from '@wharfkit/antelope'
-import {ServerContract} from '../contracts'
-import type {CoordinatesType} from '../types'
-import {Location} from './location'
-import {ScheduleAccessor} from '../scheduling/accessor'
-import {InventoryAccessor} from './inventory-accessor'
-import type {EntityInventory} from './entity-inventory'
-import type {PackedModuleInput} from './ship'
-import {decodeCraftedItemStats} from '../derivation/crafting'
-import {getModuleCapabilityType, MODULE_GATHERER, MODULE_GENERATOR} from '../capabilities/modules'
-import {computeGathererCapabilities, computeGeneratorCapabilities} from './ship-deploy'
-import {applySlotMultiplier, clampUint16, getSlotAmp, type InstalledModule} from './slot-multiplier'
-import type {EntitySlot} from '../data/recipes-runtime'
-import {getItem} from '../data/catalog'
-
-export interface ExtractorStateInput {
-    id: UInt64Type
-    owner: string
-    name: string
-    coordinates: CoordinatesType | {x: number; y: number; z?: number}
-    hullmass?: number
-    capacity?: number
-    energy?: number
-    modules?: PackedModuleInput[]
-    schedule?: ServerContract.Types.schedule
-    cargo?: ServerContract.Types.cargo_item[]
-}
-
-export class Extractor extends ServerContract.Types.entity_info {
-    private _sched?: ScheduleAccessor
-    private _inv?: InventoryAccessor
-
-    get name(): string {
-        return this.entity_name
-    }
-
-    get entityClass(): 'building' {
-        return 'building'
-    }
-
-    get canDemolish(): boolean {
-        return true
-    }
-
-    get inv(): InventoryAccessor {
-        this._inv ??= new InventoryAccessor(this)
-        return this._inv
-    }
-
-    get inventory(): EntityInventory[] {
-        return this.inv.items
-    }
-
-    get sched(): ScheduleAccessor {
-        this._sched ??= new ScheduleAccessor(this)
-        return this._sched
-    }
-
-    get isIdle(): boolean {
-        return this.is_idle
-    }
-
-    get location(): Location {
-        return Location.from(this.coordinates)
-    }
-
-    get totalCargoMass(): UInt64 {
-        return this.inv.totalMass
-    }
-
-    get maxCapacity(): UInt64 {
-        return UInt64.from(this.capacity)
-    }
-
-    get availableCapacity(): UInt64 {
-        const cargo = this.totalCargoMass
-        return cargo.gte(this.maxCapacity) ? UInt64.from(0) : this.maxCapacity.subtracting(cargo)
-    }
-
-    get isFull(): boolean {
-        return this.totalCargoMass.gte(this.maxCapacity)
-    }
-
-    get totalMass(): UInt64 {
-        const hull = this.hullmass ? UInt64.from(this.hullmass) : UInt64.from(0)
-        return hull.adding(this.totalCargoMass)
-    }
-}
-
-export interface ExtractorCapabilities {
-    generator?: {capacity: number; recharge: number}
-    gatherer?: {yield: number; drain: number; depth: number; speed: number}
-}
-
-export function computeExtractorCapabilities(
-    modules: InstalledModule[],
-    layout: EntitySlot[]
-): ExtractorCapabilities {
-    const out: ExtractorCapabilities = {}
-
-    const genModules = modules.filter((m) => getModuleCapabilityType(m.itemId) === MODULE_GENERATOR)
-    if (genModules.length > 0) {
-        let totalCapacity = 0
-        let totalRecharge = 0
-        for (const m of genModules) {
-            const caps = computeGeneratorCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            const amp = getSlotAmp(layout, m.slotIndex)
-            totalCapacity += applySlotMultiplier(caps.capacity, amp)
-            totalRecharge += applySlotMultiplier(caps.recharge, amp)
-        }
-        out.generator = {
-            capacity: clampUint16(totalCapacity),
-            recharge: clampUint16(totalRecharge),
-        }
-    }
-
-    const gathModules = modules.filter((m) => getModuleCapabilityType(m.itemId) === MODULE_GATHERER)
-    if (gathModules.length > 0) {
-        let totalYield = 0
-        let totalDrain = 0
-        let maxDepth = 0
-        let totalSpeed = 0
-        for (const m of gathModules) {
-            const tier = getItem(m.itemId).tier
-            const caps = computeGathererCapabilities(
-                decodeCraftedItemStats(m.itemId, m.stats),
-                tier
-            )
-            const amp = getSlotAmp(layout, m.slotIndex)
-            totalYield += applySlotMultiplier(caps.yield, amp)
-            totalDrain += caps.drain
-            if (caps.depth > maxDepth) maxDepth = caps.depth
-            totalSpeed += applySlotMultiplier(caps.speed, amp)
-        }
-        out.gatherer = {
-            yield: clampUint16(totalYield),
-            drain: totalDrain,
-            depth: maxDepth,
-            speed: clampUint16(totalSpeed),
-        }
-    }
-
-    return out
-}