@shipload/sdk 1.0.0-next.2 → 1.0.0-next.21

package/src/types.ts

@@ -1,6 +1,5 @@
 import {
     type Int64Type,
-    Name,
     type UInt16,
     type UInt16Type,
     type UInt32,
@@ -12,7 +11,7 @@ import {ServerContract} from './contracts'
 export const PRECISION = 10000
 export const CRAFT_ENERGY_DIVISOR = 150000
 
-export const WAREHOUSE_Z = 500
+export const PLANETARY_STRUCTURE_Z = 0
 
 export const CONTAINER_Z = 300
 
@@ -23,6 +22,8 @@ export const MAX_ORBITAL_ALTITUDE = 3000
 
 export const BASE_ORBITAL_MASS = 100000
 
+export const MIN_TRANSFER_DISTANCE = 100
+
 export interface ShipLike {
     coordinates: ServerContract.Types.coordinates
     hullmass?: UInt32
@@ -49,8 +50,11 @@ export enum TaskType {
     WARP = 6,
     CRAFT = 7,
     DEPLOY = 8,
-    WRAP = 9,
     UNWRAP = 10,
+    UNDEPLOY = 11,
+    DEMOLISH = 13,
+    CLAIMPLOT = 14,
+    BUILDPLOT = 15,
 }
 
 export enum LocationType {
@@ -58,6 +62,7 @@ export enum LocationType {
     PLANET = 1,
     ASTEROID = 2,
     NEBULA = 3,
+    ICE_FIELD = 4,
 }
 
 export enum TaskCancelable {
@@ -66,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
@@ -122,8 +119,9 @@ export type ModuleType =
     | 'launcher'
     | 'storage'
     | 'hauler'
+    | 'battery'
 
-export const TIER_ADJECTIVES: Record<number, string> = {
+export const RESOURCE_TIER_ADJECTIVES: Record<number, string> = {
     1: 'Crude',
     2: 'Dense',
     3: 'Pure',
@@ -136,6 +134,9 @@ export const TIER_ADJECTIVES: Record<number, string> = {
     10: 'Ascendant',
 }
 
+export const COMPONENT_TIER_PREFIXES: Record<number, string> = {}
+export const MODULE_TIER_PREFIXES: Record<number, string> = {}
+
 export const CATEGORY_LABELS: Record<ResourceCategory, string> = {
     ore: 'Ore',
     crystal: 'Crystal',
@@ -159,3 +160,7 @@ export interface Item {
 export function formatTier(tier: number): string {
     return 'T' + tier
 }
+
+export function tierAdjective(tier: number): string {
+    return RESOURCE_TIER_ADJECTIVES[tier] ?? `T${tier}`
+}

package/src/utils/cargo.ts

@@ -0,0 +1,27 @@
+import type {ServerContract} from '../contracts'
+
+export function cargoRef(src: {
+    item_id: number
+    stats: bigint | number
+    modules?: ServerContract.Types.module_entry[]
+}): ServerContract.ActionParams.Type.cargo_ref {
+    return {
+        item_id: src.item_id,
+        stats: src.stats,
+        modules: src.modules ?? [],
+    }
+}
+
+export function cargoItem(
+    src: {
+        item_id: number
+        stats: bigint | number
+        modules?: ServerContract.Types.module_entry[]
+    },
+    quantity: bigint | number
+): ServerContract.ActionParams.Type.cargo_item {
+    return {
+        ...cargoRef(src),
+        quantity,
+    }
+}

package/src/utils/system.ts

@@ -8,7 +8,6 @@ import nebulaAdjectives from '../data/nebula-adjectives.json'
 import nebulaNouns from '../data/nebula-nouns.json'
 
 const LOCATION_EXISTS_THRESHOLD = 0x10
-const LOCATION_ACTIVE_THRESHOLD = 0x80
 
 export function getLocationType(
     gameSeed: Checksum256Type,
@@ -22,12 +21,10 @@ export function getLocationType(
         return LocationType.EMPTY
     }
 
-    if (hashResult.array[1] < 96) {
-        return LocationType.PLANET
-    } else if (hashResult.array[1] < 176) {
-        return LocationType.ASTEROID
-    }
-    return LocationType.NEBULA
+    if (hashResult.array[1] < 96) return LocationType.PLANET
+    if (hashResult.array[1] < 149) return LocationType.ASTEROID
+    if (hashResult.array[1] < 202) return LocationType.NEBULA
+    return LocationType.ICE_FIELD
 }
 
 export function isGatherableLocation(locationType: LocationType): boolean {
@@ -44,6 +41,8 @@ export function getLocationTypeName(type: LocationType): string {
             return 'Asteroid'
         case LocationType.NEBULA:
             return 'Nebula'
+        case LocationType.ICE_FIELD:
+            return 'Ice Field'
     }
 }
 
@@ -76,6 +75,15 @@ function generateNebulaName(hashResult: Checksum512): string {
     return `${nebulaAdjectives[adjIdx]} ${nebulaNouns[nounIdx]}`
 }
 
+function generateIceFieldName(hashResult: Checksum512): string {
+    const A = 65
+    const letter1 = String.fromCharCode(A + (hashResult.array[0] % 26))
+    const letter2 = String.fromCharCode(A + (hashResult.array[1] % 26))
+    const subId = (hashResult.array[2] % 9) + 1
+    const num = (uint16(hashResult, 3) % 9000) + 1000
+    return `${letter1}${letter2}-${subId}/${num}`
+}
+
 export function getSystemName(gameSeed: Checksum256Type, location: CoordinatesType): string {
     const seed = Checksum256.from(gameSeed)
     const locationType = getLocationType(seed, location)
@@ -91,6 +99,8 @@ export function getSystemName(gameSeed: Checksum256Type, location: CoordinatesTy
             return generateAsteroidName(hashResult)
         case LocationType.NEBULA:
             return generateNebulaName(hashResult)
+        case LocationType.ICE_FIELD:
+            return generateIceFieldName(hashResult)
         default:
             return generatePlanetName(hashResult)
     }
@@ -123,10 +133,12 @@ export function deriveLocationStatic(
 
     if (hashResult.array[1] < 96) {
         loc.type = UInt8.from(LocationType.PLANET)
-    } else if (hashResult.array[1] < 176) {
+    } else if (hashResult.array[1] < 149) {
         loc.type = UInt8.from(LocationType.ASTEROID)
-    } else {
+    } else if (hashResult.array[1] < 202) {
         loc.type = UInt8.from(LocationType.NEBULA)
+    } else {
+        loc.type = UInt8.from(LocationType.ICE_FIELD)
     }
 
     loc.subtype = UInt8.from(
@@ -138,31 +150,20 @@ export function deriveLocationStatic(
     return loc
 }
 
-export function deriveLocationEpoch(
-    epochSeed: Checksum256Type,
+export function isLocationBuildable(
+    gameSeed: Checksum256Type,
     coordinates: CoordinatesType
-): ServerContract.Types.location_epoch {
-    const seed = Checksum256.from(epochSeed)
-    const coords = Coordinates.from(coordinates)
-    const str = `system-epoch-${coords.x}-${coords.y}`
-    const hashResult = hash512(seed, str)
-
-    return ServerContract.Types.location_epoch.from({
-        active: hashResult.array[0] < LOCATION_ACTIVE_THRESHOLD,
-        seed0: hashResult.array[1],
-        seed1: hashResult.array[2],
-    })
+): boolean {
+    return getLocationType(gameSeed, coordinates) === LocationType.PLANET
 }
 
 export function deriveLocation(
     gameSeed: Checksum256Type,
-    epochSeed: Checksum256Type,
     coordinates: CoordinatesType
 ): ServerContract.Types.location_derived {
     const staticProps = deriveLocationStatic(gameSeed, coordinates)
     return ServerContract.Types.location_derived.from({
         static_props: staticProps,
-        epoch_props: deriveLocationEpoch(epochSeed, coordinates),
         size: deriveLocationSize(staticProps),
     })
 }

package/src/entities/container.ts

@@ -1,108 +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 * 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 sched(): ScheduleAccessor {
-        this._sched ??= new ScheduleAccessor(this)
-        return this._sched
-    }
-
-    get isIdle(): boolean {
-        return this.is_idle
-    }
-
-    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'] ?? 500
-    const strength = stats['strength'] ?? 500
-    const hardness = stats['hardness'] ?? 500
-    const saturation = stats['saturation'] ?? 500
-
-    const hullmass = 25000 + 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'] ?? 0
-    const density = stats['density'] ?? 0
-    const hardness = stats['hardness'] ?? 0
-    const saturation = stats['saturation'] ?? 0
-
-    const hullmass = 20000 + 50 * density
-
-    const statSum = strength + hardness + saturation
-    const exponent = statSum / 2500
-    const capacity = Math.floor(1500000 * 10 ** exponent)
-
-    return {hullmass, capacity}
-}

package/src/entities/ship-deploy.ts

@@ -1,258 +0,0 @@
-import {decodeCraftedItemStats} from '../derivation/crafting'
-import {
-    getModuleCapabilityType,
-    MODULE_CRAFTER,
-    MODULE_ENGINE,
-    MODULE_GATHERER,
-    MODULE_GENERATOR,
-    MODULE_HAULER,
-    MODULE_LOADER,
-} from '../capabilities/modules'
-
-export function computeShipHullCapabilities(stats: Record<string, number>): {
-    hullmass: number
-    capacity: number
-} {
-    const density = stats.density ?? 500
-    const strength = stats.strength ?? 500
-    const hardness = stats.hardness ?? 500
-    const saturation = stats.saturation ?? 500
-
-    const hullmass = 25000 + 75 * density
-    const statSum = strength + hardness + saturation
-    const exponent = statSum / 2997.0
-    const capacity = Math.floor(1000000 * 10 ** exponent)
-
-    return {hullmass, capacity}
-}
-
-export function computeEngineCapabilities(stats: Record<string, number>): {
-    thrust: number
-    drain: number
-} {
-    const vol = stats.volatility ?? 500
-    const thm = stats.thermal ?? 500
-
-    return {
-        thrust: 400 + Math.floor((vol * 3) / 4),
-        drain: Math.max(30, 50 - Math.floor(thm / 70)),
-    }
-}
-
-export function computeGeneratorCapabilities(stats: Record<string, number>): {
-    capacity: number
-    recharge: number
-} {
-    const res = stats.resonance ?? 500
-    const ref = stats.reflectivity ?? 500
-
-    return {
-        capacity: 300 + Math.floor(res / 6),
-        recharge: 1 + Math.floor((ref * 3) / 1000),
-    }
-}
-
-export function computeGathererCapabilities(stats: Record<string, number>): {
-    yield: number
-    drain: number
-    depth: number
-    speed: number
-} {
-    const str = stats.strength ?? 500
-    const con = stats.conductivity ?? 500
-    const ref = stats.reflectivity ?? 500
-    const tol = stats.tolerance ?? 500
-
-    return {
-        yield: 200 + str,
-        drain: Math.max(250, 1250 - Math.floor((con * 25) / 20)),
-        depth: 200 + Math.floor((tol * 3) / 2),
-        speed: 100 + Math.floor((ref * 4) / 5),
-    }
-}
-
-export function computeLoaderCapabilities(stats: Record<string, number>): {
-    mass: number
-    thrust: number
-    quantity: number
-} {
-    const hrd = stats.hardness ?? 500
-    const pla = stats.plasticity ?? 500
-
-    return {
-        mass: Math.max(200, 2000 - Math.floor(hrd * 2)),
-        thrust: 1 + Math.floor(pla / 500),
-        quantity: 1,
-    }
-}
-
-export function computeCrafterCapabilities(stats: Record<string, number>): {
-    speed: number
-    drain: number
-} {
-    const rea = stats.reactivity ?? 500
-    const com = stats.composition ?? 500
-
-    return {
-        speed: 100 + Math.floor((rea * 4) / 5),
-        drain: Math.max(5, 30 - Math.floor(com / 33)),
-    }
-}
-
-export function computeHaulerCapabilities(stats: Record<string, number>): {
-    capacity: number
-    efficiency: number
-    drain: number
-} {
-    const res = stats.resonance ?? 500
-    const con = stats.conductivity ?? 500
-    const ref = stats.reflectivity ?? 500
-
-    return {
-        capacity: Math.max(1, 1 + Math.floor(res / 400)),
-        efficiency: 2000 + con * 6,
-        drain: Math.max(3, 15 - Math.floor(ref / 80)),
-    }
-}
-
-export function computeStorageCapabilities(
-    stats: Record<string, number>,
-    baseCapacity: number
-): {
-    capacityBonus: number
-} {
-    const strength = stats.strength ?? 500
-    const hardness = stats.hardness ?? 500
-    const saturation = stats.saturation ?? 500
-
-    const statSum = strength + hardness + saturation
-    const capacityBonus = Math.floor(
-        (baseCapacity * (10 + Math.floor((statSum * 10) / 2997))) / 100
-    )
-
-    return {capacityBonus}
-}
-
-export function computeWarehouseHullCapabilities(stats: Record<string, number>): {
-    hullmass: number
-    capacity: number
-} {
-    const density = stats.density ?? 500
-    const strength = stats.strength ?? 500
-    const hardness = stats.hardness ?? 500
-    const saturation = stats.saturation ?? 500
-
-    const hullmass = 25000 + 75 * density
-    const statSum = strength + hardness + saturation
-    const exponent = statSum / 2997.0
-    const capacity = Math.floor(20000000 * 10 ** exponent)
-
-    return {hullmass, capacity}
-}
-
-export interface ShipCapabilities {
-    engines?: {thrust: number; drain: number}
-    generator?: {capacity: number; recharge: number}
-    gatherer?: {yield: number; drain: number; depth: number; speed: number}
-    hauler?: {capacity: number; efficiency: number; drain: number}
-    loaders?: {mass: number; thrust: number; quantity: number}
-    crafter?: {speed: number; drain: number}
-}
-
-export function computeShipCapabilities(
-    modules: {itemId: number; stats: bigint}[]
-): ShipCapabilities {
-    const ship: ShipCapabilities = {}
-
-    const engineModules = modules.filter((m) => getModuleCapabilityType(m.itemId) === MODULE_ENGINE)
-    if (engineModules.length > 0) {
-        let totalThrust = 0
-        let totalDrain = 0
-        for (const m of engineModules) {
-            const caps = computeEngineCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            totalThrust += caps.thrust
-            totalDrain += caps.drain
-        }
-        ship.engines = {thrust: totalThrust, drain: totalDrain}
-    }
-
-    const generatorModules = modules.filter(
-        (m) => getModuleCapabilityType(m.itemId) === MODULE_GENERATOR
-    )
-    if (generatorModules.length > 0) {
-        let totalCapacity = 0
-        let totalRecharge = 0
-        for (const m of generatorModules) {
-            const caps = computeGeneratorCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            totalCapacity += caps.capacity
-            totalRecharge += caps.recharge
-        }
-        ship.generator = {capacity: totalCapacity, recharge: totalRecharge}
-    }
-
-    const gathererModules = modules.filter(
-        (m) => getModuleCapabilityType(m.itemId) === MODULE_GATHERER
-    )
-    if (gathererModules.length > 0) {
-        let totalYield = 0
-        let totalDrain = 0
-        let totalDepth = 0
-        let totalSpeed = 0
-        for (const m of gathererModules) {
-            const caps = computeGathererCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            totalYield += caps.yield
-            totalDrain += caps.drain
-            totalDepth += caps.depth
-            totalSpeed += caps.speed
-        }
-        ship.gatherer = {yield: totalYield, drain: totalDrain, depth: totalDepth, speed: totalSpeed}
-    }
-
-    const haulerModules = modules.filter((m) => getModuleCapabilityType(m.itemId) === MODULE_HAULER)
-    if (haulerModules.length > 0) {
-        let totalCapacity = 0
-        let weightedEffNum = 0
-        let totalDrain = 0
-        for (const m of haulerModules) {
-            const caps = computeHaulerCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            totalCapacity += caps.capacity
-            weightedEffNum += caps.efficiency * caps.capacity
-            totalDrain += caps.drain
-        }
-        ship.hauler = {
-            capacity: totalCapacity,
-            efficiency: totalCapacity > 0 ? Math.floor(weightedEffNum / totalCapacity) : 0,
-            drain: totalDrain,
-        }
-    }
-
-    const loaderModules = modules.filter((m) => getModuleCapabilityType(m.itemId) === MODULE_LOADER)
-    if (loaderModules.length > 0) {
-        let totalMass = 0
-        let totalThrust = 0
-        let totalQuantity = 0
-        for (const m of loaderModules) {
-            const caps = computeLoaderCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            totalMass += caps.mass
-            totalThrust += caps.thrust
-            totalQuantity += caps.quantity
-        }
-        ship.loaders = {mass: totalMass, thrust: totalThrust, quantity: totalQuantity}
-    }
-
-    const crafterModules = modules.filter(
-        (m) => getModuleCapabilityType(m.itemId) === MODULE_CRAFTER
-    )
-    if (crafterModules.length > 0) {
-        let totalSpeed = 0
-        let totalDrain = 0
-        for (const m of crafterModules) {
-            const caps = computeCrafterCapabilities(decodeCraftedItemStats(m.itemId, m.stats))
-            totalSpeed += caps.speed
-            totalDrain += caps.drain
-        }
-        ship.crafter = {speed: totalSpeed, drain: totalDrain}
-    }
-
-    return ship
-}