@shipload/sdk 0.3.3 → 0.3.5

package/lib/shipload.d.ts

@@ -1,4 +1,4 @@
-import { Blob, ABI, Struct, Name, UInt64, Checksum256, UInt32, TimePointSec, Checksum256Type, UInt32Type, NameType, UInt64Type, Action, UInt16, Int64, TimePoint, UInt8, Int64Type, UInt16Type, Checksum512, APIClient } from '@wharfkit/antelope';
+import { Blob, ABI, Struct, Name, UInt64, Checksum256, UInt32, TimePointSec, Checksum256Type, UInt32Type, NameType, UInt64Type, Action, UInt16, Int64, TimePoint, UInt8, Float64, Int64Type, UInt16Type, Checksum512, APIClient } from '@wharfkit/antelope';
 import { Contract as Contract$2, PartialBy, ContractArgs, ActionOptions, Table } from '@wharfkit/contract';
 import { ChainDefinition } from '@wharfkit/session';
 
@@ -161,7 +161,6 @@ declare namespace Types {
         commit: Checksum256;
     }
     class arrive extends Struct {
-        owner: Name;
         id: UInt64;
     }
     class buygoods extends Struct {
@@ -248,9 +247,14 @@ declare namespace Types {
         thrust: UInt64;
     }
     class travel_plan extends Struct {
-        destination: coordinates;
         departure: TimePoint;
-        duration: UInt32;
+        destination: coordinates;
+        flighttime: UInt32;
+        loadtime: UInt32;
+        rechargetime: UInt32;
+        mass: UInt64;
+        energyusage: UInt32;
+        distance: UInt64;
     }
     class ship_row extends Struct {
         id: UInt64;
@@ -272,7 +276,6 @@ declare namespace Types {
         commit: Checksum256;
     }
     class travel extends Struct {
-        owner: Name;
         id: UInt64;
         destination: coordinates;
         recharge: boolean;
@@ -284,13 +287,19 @@ declare namespace Types {
         destination: coordinates;
         distance: UInt64;
         totalmass: UInt64;
-        acceleration: UInt64;
+        acceleration: Float64;
         flighttime: UInt64;
         energyusage: UInt64;
         rechargetime: UInt64;
         loadtime: UInt64;
         time: UInt64;
     }
+    class travelplan extends Struct {
+        id: UInt64;
+        origin: coordinates;
+        destination: coordinates;
+        recharge: boolean;
+    }
     class traveltime extends Struct {
         id: UInt64;
         destination: coordinates;
@@ -326,7 +335,6 @@ declare namespace ActionParams {
         commit: Checksum256Type;
     }
     interface arrive {
-        owner: NameType;
         id: UInt64Type;
     }
     interface buygoods {
@@ -373,11 +381,16 @@ declare namespace ActionParams {
         quantity: UInt64Type;
     }
     interface travel {
-        owner: NameType;
         id: UInt64Type;
         destination: Type.coordinates;
         recharge: boolean;
     }
+    interface travelplan {
+        id: UInt64Type;
+        origin: Type.coordinates;
+        destination: Type.coordinates;
+        recharge: boolean;
+    }
     interface traveltime {
         id: UInt64Type;
         destination: Type.coordinates;
@@ -401,6 +414,7 @@ interface ActionNameParams {
     salt: ActionParams.salt;
     sellgoods: ActionParams.sellgoods;
     travel: ActionParams.travel;
+    travelplan: ActionParams.travelplan;
     traveltime: ActionParams.traveltime;
     wipe: ActionParams.wipe;
 }
@@ -410,6 +424,7 @@ interface ActionReturnValues {
     hash512: Checksum512;
     marketprice: Types.good_price;
     marketprices: Types.good_price[];
+    travelplan: Types.travel_plan;
     traveltime: Types.travel_summary;
 }
 type ActionReturnNames = keyof ActionReturnValues;
@@ -452,16 +467,13 @@ declare namespace server {
   };
 }
 
-declare function getCurrentEpoch(game: Types$1.game_row): Promise<number>;
+declare function getCurrentEpoch(game: Types$1.game_row): number;
 
 declare function hash(seed: Checksum256Type, string: string): Checksum512;
 declare function hash512(seed: Checksum256Type, string: string): Checksum512;
 
-interface Coordinates {
-    x: number;
-    y: number;
-}
-interface CameraPosition extends Coordinates {
+declare const PRECISION = 10000;
+interface CameraPosition extends ActionParams.Type.coordinates {
     z: number;
 }
 interface Dimensions {
@@ -480,24 +492,45 @@ interface Good {
     base_price: UInt64;
     mass: UInt64;
 }
+interface GoodType {
+    id: UInt16Type;
+    name: string;
+    description: string;
+    base_price: UInt64Type;
+    mass: UInt64Type;
+}
 interface GoodPrice {
-    id: UInt16;
+    good: Good;
     price: UInt64;
 }
 
-declare function distanceTraveled(ship: Types.ship_row): number;
-declare function distanceBetweenCoordinates(origin: ActionParams.Type.coordinates, destination: ActionParams.Type.coordinates): UInt16;
-declare function distanceBetweenPoints(x1: UInt64Type, y1: UInt64Type, x2: UInt64Type, y2: UInt64Type): UInt16;
+declare function travelplanDuration(travelplan: Types.travel_plan): UInt32;
+declare function distanceTraveled(ship: Types.ship_row, current?: Date): number;
+declare function distanceBetweenCoordinates(origin: ActionParams.Type.coordinates, destination: ActionParams.Type.coordinates): UInt64;
+declare function distanceBetweenPoints(x1: Int64Type, y1: Int64Type, x2: Int64Type, y2: Int64Type): UInt64;
 declare function lerp(origin: ActionParams.Type.coordinates, destination: ActionParams.Type.coordinates, time: number): ActionParams.Type.coordinates;
 declare function rotation(origin: ActionParams.Type.coordinates, destination: ActionParams.Type.coordinates): number;
-declare function hasPlanet(seed: Checksum256, coordinates: ActionParams.Type.coordinates): boolean;
-declare function findNearbyPlanets(seed: Checksum256, origin: ActionParams.Type.coordinates, maxDistance?: UInt16Type): Distance[];
+declare function hasSystem(seed: Checksum256, coordinates: ActionParams.Type.coordinates): boolean;
+declare function findNearbyPlanets(seed: Checksum256, origin: ActionParams.Type.coordinates, maxDistance?: UInt64Type): Distance[];
+declare function travelplan(game: Types$1.game_row, ship: Types.ship_row, cargos: Types.cargo_row[], origin: ActionParams.Type.coordinates, destination: ActionParams.Type.coordinates, recharge: boolean): Types.travel_plan;
+declare function calc_rechargetime(capacity: UInt32Type, energy: UInt32Type, recharge: UInt32Type): UInt32;
+declare function calc_ship_rechargetime(ship: Types.ship_row): UInt32;
+declare function calc_ship_loadtime(ship: Types.ship_row, cargos: Types.cargo_row[]): UInt32;
+declare function calc_flighttime(distance: UInt64Type, acceleration: number): UInt32;
+declare function calc_loader_flighttime(ship: Types.ship_row, mass: UInt64): UInt32;
+declare function calc_loader_acceleration(ship: Types.ship_row, mass: UInt64): number;
+declare function calc_ship_flighttime(ship: Types.ship_row, mass: UInt64, distance: UInt64): UInt32;
+declare function calc_ship_acceleration(ship: Types.ship_row, mass: UInt64): number;
+declare function calc_acceleration(thrust: number, mass: number): number;
+declare function calc_ship_mass(ship: Types.ship_row, cargos: Types.cargo_row[]): UInt64;
+declare function calc_energyusage(drain: UInt32Type, flighttime: UInt32Type): UInt32;
 
-declare const goods: Good[];
+declare const goodIds: any[];
 declare function getGood(good_id: UInt16Type): Good;
+declare function getGoods(): Good[];
 
-declare function marketprice(location: Coordinates, good_id: UInt16Type, gameSeed: Checksum256Type, epochSeed: Checksum256Type): Promise<UInt64>;
-declare function marketprices(location: Coordinates, gameSeed: Checksum256Type, epochSeed: Checksum256Type): Promise<GoodPrice[]>;
+declare function marketprice(location: ActionParams.Type.coordinates, good_id: UInt16Type, gameSeed: Checksum256Type, epochSeed: Checksum256Type): Promise<UInt64>;
+declare function marketprices(location: ActionParams.Type.coordinates, gameSeed: Checksum256Type, epochSeed: Checksum256Type): Promise<GoodPrice[]>;
 declare function priceFromRoll(basePrice: UInt64Type, roll: number): UInt64;
 
 declare const ERROR_SYSTEM_NOT_INITIALIZED = "System not initialized";
@@ -516,19 +549,22 @@ interface ShiploadOptions {
     client?: APIClient;
 }
 interface ShiploadConstructorOptions extends ShiploadOptions {
-    platformContract: Contract$2;
-    serverContract: Contract$2;
+    platformContract?: Contract$2;
+    serverContract?: Contract$2;
 }
 declare class Shipload {
     client: APIClient;
     server: Contract$2;
     platform: Contract$2;
-    constructor(chain: ChainDefinition, { client, platformContract, serverContract }: ShiploadConstructorOptions);
-    static load(chain: ChainDefinition, shiploadOptions: ShiploadOptions): Promise<Shipload>;
+    constructor(chain: ChainDefinition, constructorOptions?: ShiploadConstructorOptions);
+    static load(chain: ChainDefinition, shiploadOptions?: ShiploadOptions): Promise<Shipload>;
     getGame(): Promise<Types$1.game_row>;
     getState(): Promise<Types.state_row>;
-    marketprice(location: Coordinates, good_id: number): Promise<UInt64>;
-    marketprices(location: Coordinates): Promise<GoodPrice[]>;
+    marketprice(location: ActionParams.Type.coordinates, good_id: number): Promise<UInt64>;
+    marketprices(location: ActionParams.Type.coordinates): Promise<GoodPrice[]>;
+    hasSystem(location: ActionParams.Type.coordinates): Promise<boolean>;
+    findNearbyPlanets(origin: ActionParams.Type.coordinates, maxDistance?: UInt16Type): Promise<Distance[]>;
+    travelplan(ship: Types.ship_row, origin: ActionParams.Type.coordinates, destination: ActionParams.Type.coordinates, recharge?: boolean): Promise<Types.travel_plan>;
 }
 
-export { CameraPosition, Coordinates, Dimensions, Distance, ERROR_SYSTEM_NOT_INITIALIZED, GOOD_DOES_NOT_EXIST, GOOD_NOT_AVAILABLE_AT_LOCATION, Good, GoodPrice, INSUFFICIENT_BALANCE, INSUFFICIENT_GOOD_QUANTITY, PLAYER_NOT_FOUND, platform as PlatformContract, REQUIRES_MORE_THAN_ONE, SHIP_CANNOT_BUY_TRAVELING, SHIP_NOT_FOUND, server as ServerContract, Shipload as default, distanceBetweenCoordinates, distanceBetweenPoints, distanceTraveled, findNearbyPlanets, getCurrentEpoch, getGood, goods, hasPlanet, hash, hash512, lerp, marketprice, marketprices, priceFromRoll, rotation };
+export { CameraPosition, Dimensions, Distance, ERROR_SYSTEM_NOT_INITIALIZED, GOOD_DOES_NOT_EXIST, GOOD_NOT_AVAILABLE_AT_LOCATION, Good, GoodPrice, GoodType, INSUFFICIENT_BALANCE, INSUFFICIENT_GOOD_QUANTITY, PLAYER_NOT_FOUND, PRECISION, platform as PlatformContract, REQUIRES_MORE_THAN_ONE, SHIP_CANNOT_BUY_TRAVELING, SHIP_NOT_FOUND, server as ServerContract, calc_acceleration, calc_energyusage, calc_flighttime, calc_loader_acceleration, calc_loader_flighttime, calc_rechargetime, calc_ship_acceleration, calc_ship_flighttime, calc_ship_loadtime, calc_ship_mass, calc_ship_rechargetime, Shipload as default, distanceBetweenCoordinates, distanceBetweenPoints, distanceTraveled, findNearbyPlanets, getCurrentEpoch, getGood, getGoods, goodIds, hasSystem, hash, hash512, lerp, marketprice, marketprices, priceFromRoll, rotation, travelplan, travelplanDuration };