@shipload/sdk 1.0.0-next.11 → 1.0.0-next.13

package/lib/testing.d.ts

@@ -0,0 +1,713 @@
+import { Struct, UInt16, UInt64, UInt8, Int64, Checksum256, UInt32, Name, TimePoint, Bytes, Int32, Int64Type } from '@wharfkit/antelope';
+
+declare const CATALOG_FILES_REL: readonly ["items.json", "recipes.json", "entities.json", "kind-registry.json", "item-ids.ts"];
+declare function computeCatalogHash(filePaths: ReadonlyArray<string>): string;
+
+declare namespace Types {
+    class packed_module extends Struct {
+        item_id: UInt16;
+        stats: UInt64;
+    }
+    class module_entry extends Struct {
+        type: UInt8;
+        installed?: packed_module;
+    }
+    class cargo_ref extends Struct {
+        item_id: UInt16;
+        stats: UInt64;
+        modules: module_entry[];
+    }
+    class addmodule extends Struct {
+        entity_id: UInt64;
+        module_index: UInt8;
+        module_ref: cargo_ref;
+        target_ref?: cargo_ref;
+    }
+    class addnexus extends Struct {
+        nexus_name: string;
+        x: Int64;
+        y: Int64;
+    }
+    class advance extends Struct {
+        reveal: string;
+        commit: Checksum256;
+    }
+    class cargo_item extends Struct {
+        item_id: UInt16;
+        stats: UInt64;
+        modules: module_entry[];
+        quantity: UInt32;
+    }
+    class blend extends Struct {
+        id: UInt64;
+        inputs: cargo_item[];
+    }
+    class cancel extends Struct {
+        id: UInt64;
+        count: UInt64;
+    }
+    class entity_ref extends Struct {
+        entity_type: Name;
+        entity_id: UInt64;
+    }
+    class cancel_results extends Struct {
+        entity_id: UInt64;
+        entity_type: Name;
+        cancelled_count: UInt8;
+        schedule_started?: TimePoint;
+        entitygroup?: UInt64;
+        group_members?: entity_ref[];
+    }
+    class cargo_row extends Struct {
+        id: UInt64;
+        entity_id: UInt64;
+        item_id: UInt64;
+        quantity: UInt64;
+        stats: UInt64;
+        modules: module_entry[];
+    }
+    class cargo_view extends Struct {
+        item_id: UInt16;
+        stats: UInt64;
+        modules: module_entry[];
+        quantity: UInt32;
+        id: UInt64;
+    }
+    class claimstarter extends Struct {
+        account: Name;
+        x: Int64;
+        y: Int64;
+    }
+    class cleanrsvp extends Struct {
+        epoch: UInt64;
+        max_rows: UInt64;
+    }
+    class cleartable extends Struct {
+        table_name: Name;
+        scope?: Name;
+        max_rows?: UInt64;
+    }
+    class commit extends Struct {
+        commit: Checksum256;
+    }
+    class entity_defaults extends Struct {
+        warehouse_z: UInt16;
+        container_z: UInt16;
+    }
+    class item_def extends Struct {
+        id: UInt16;
+        mass: UInt32;
+        type: UInt8;
+        subtype: UInt8;
+        tier: UInt8;
+    }
+    class game_config extends Struct {
+        version: UInt32;
+        defaults: entity_defaults;
+        items: item_def[];
+    }
+    class configlog extends Struct {
+        config: game_config;
+    }
+    class coordinates extends Struct {
+        x: Int64;
+        y: Int64;
+        z?: UInt16;
+    }
+    class craft extends Struct {
+        id: UInt64;
+        recipe_id: UInt16;
+        quantity: UInt32;
+        inputs: cargo_item[];
+    }
+    class crafter_stats extends Struct {
+        speed: UInt16;
+        drain: UInt16;
+    }
+    class createentity extends Struct {
+        owner: Name;
+        entity_type: Name;
+        entity_name: string;
+        x: Int64;
+        y: Int64;
+    }
+    class demolish extends Struct {
+        entity_id: UInt64;
+    }
+    class deploy extends Struct {
+        id: UInt64;
+        ref: cargo_ref;
+    }
+    class descentity extends Struct {
+        item_id: UInt16;
+        hull_stats: UInt64;
+        module_items: UInt16[];
+        module_stats: UInt64[];
+    }
+    class enable extends Struct {
+        enabled: boolean;
+    }
+    class energy_stats extends Struct {
+        capacity: UInt16;
+        recharge: UInt16;
+    }
+    class entity_current_state extends Struct {
+        coordinates: coordinates;
+        energy: UInt16;
+    }
+    class loader_stats extends Struct {
+        mass: UInt32;
+        thrust: UInt16;
+        quantity: UInt8;
+    }
+    class movement_stats extends Struct {
+        thrust: UInt32;
+        drain: UInt16;
+    }
+    class gatherer_stats extends Struct {
+        yield: UInt16;
+        drain: UInt16;
+        depth: UInt16;
+        speed: UInt16;
+    }
+    class hauler_stats extends Struct {
+        capacity: UInt8;
+        efficiency: UInt16;
+        drain: UInt16;
+    }
+    class warp_stats extends Struct {
+        range: UInt32;
+    }
+    class task extends Struct {
+        type: UInt8;
+        duration: UInt32;
+        cancelable: UInt8;
+        coordinates?: coordinates;
+        cargo: cargo_item[];
+        entitytarget?: entity_ref;
+        entitygroup?: UInt64;
+        energy_cost?: UInt16;
+    }
+    class schedule extends Struct {
+        started: TimePoint;
+        tasks: task[];
+    }
+    class entity_info extends Struct {
+        type: Name;
+        id: UInt64;
+        owner: Name;
+        entity_name: string;
+        coordinates: coordinates;
+        cargomass: UInt32;
+        cargo: cargo_view[];
+        loaders?: loader_stats;
+        modules: module_entry[];
+        energy?: UInt16;
+        hullmass?: UInt32;
+        engines?: movement_stats;
+        generator?: energy_stats;
+        capacity?: UInt32;
+        gatherer?: gatherer_stats;
+        hauler?: hauler_stats;
+        warp?: warp_stats;
+        crafter?: crafter_stats;
+        is_idle: boolean;
+        current_task?: task;
+        current_task_elapsed: UInt32;
+        current_task_remaining: UInt32;
+        pending_tasks: task[];
+        idle_at?: TimePoint;
+        schedule?: schedule;
+    }
+    class slot_def extends Struct {
+        type: UInt8;
+        output_pct: UInt16;
+    }
+    class entity_layout extends Struct {
+        entity_item_id: UInt16;
+        slots: slot_def[];
+    }
+    class entity_layouts_result extends Struct {
+        entities: entity_layout[];
+    }
+    class entity_row extends Struct {
+        id: UInt64;
+        owner: Name;
+        kind: Name;
+        name: string;
+        stats: UInt64;
+        coordinates: coordinates;
+        hullmass?: UInt32;
+        capacity?: UInt32;
+        energy?: UInt16;
+        cargomass: UInt32;
+        engines?: movement_stats;
+        generator?: energy_stats;
+        loaders?: loader_stats;
+        gatherer?: gatherer_stats;
+        warp?: warp_stats;
+        crafter?: crafter_stats;
+        hauler?: hauler_stats;
+        modules: module_entry[];
+        schedule?: schedule;
+        item_id: UInt16;
+    }
+    class entity_summary extends Struct {
+        type: Name;
+        id: UInt64;
+        owner: Name;
+        entity_name: string;
+        coordinates: coordinates;
+        is_idle: boolean;
+        resolved_count: UInt32;
+        pending_count: UInt32;
+    }
+    class entity_task_info extends Struct {
+        entity_id: UInt64;
+        entity_type: Name;
+        task_count: UInt8;
+        schedule_started: TimePoint;
+    }
+    class entitygroup_row extends Struct {
+        id: UInt64;
+        participants: entity_ref[];
+    }
+    class enum_member extends Struct {
+        value: UInt8;
+        name: string;
+    }
+    class enum_result extends Struct {
+        members: enum_member[];
+    }
+    class fixcargomass extends Struct {
+        entity_id: UInt64;
+    }
+    class gather extends Struct {
+        source_id: UInt64;
+        destination_id: UInt64;
+        stratum: UInt16;
+        quantity: UInt32;
+    }
+    class getconfig extends Struct {
+    }
+    class geteligible extends Struct {
+        coords: coordinates;
+        stratum: UInt16;
+    }
+    class getentities extends Struct {
+        owner: Name;
+        entity_type?: Name;
+    }
+    class getentity extends Struct {
+        entity_id: UInt64;
+    }
+    class getitemdata extends Struct {
+    }
+    class getitemids extends Struct {
+    }
+    class getitems extends Struct {
+    }
+    class getitemtypes extends Struct {
+    }
+    class getlocation extends Struct {
+        x: Int64;
+        y: Int64;
+    }
+    class getlocdata extends Struct {
+        x: Int64;
+        y: Int64;
+    }
+    class getmodtypes extends Struct {
+    }
+    class getmodules extends Struct {
+    }
+    class getnearby extends Struct {
+        entity_id: UInt64;
+        recharge: boolean;
+    }
+    class getnftinfo extends Struct {
+    }
+    class getplayer extends Struct {
+        account: Name;
+    }
+    class getrecipe extends Struct {
+        output_item_id: UInt16;
+    }
+    class getrecipes extends Struct {
+        lower_bound: UInt16;
+        limit: UInt8;
+    }
+    class getrescats extends Struct {
+    }
+    class getreserves extends Struct {
+        x: Int64;
+        y: Int64;
+    }
+    class getresources extends Struct {
+    }
+    class getslots extends Struct {
+    }
+    class getstratum extends Struct {
+        x: Int64;
+        y: Int64;
+        stratum: UInt16;
+    }
+    class getsummaries extends Struct {
+        owner: Name;
+        entity_type?: Name;
+    }
+    class grouptravel extends Struct {
+        entities: entity_ref[];
+        x: Int64;
+        y: Int64;
+        recharge: boolean;
+    }
+    class hash extends Struct {
+        value: string;
+    }
+    class hash512 extends Struct {
+        value: string;
+    }
+    class initialize extends Struct {
+        seed: Checksum256;
+    }
+    class item_id_pair extends Struct {
+        id: UInt16;
+        name: string;
+    }
+    class item_ids_result extends Struct {
+        items: item_id_pair[];
+    }
+    class recipe_input extends Struct {
+        item_id: UInt16;
+        category: UInt8;
+        tier: UInt8;
+        quantity: UInt32;
+    }
+    class stat_source extends Struct {
+        input_index: UInt8;
+        input_stat_index: UInt8;
+    }
+    class stat_slot_response extends Struct {
+        sources: stat_source[];
+    }
+    class recipe_item_info extends Struct {
+        id: UInt16;
+        mass: UInt32;
+    }
+    class recipe_response extends Struct {
+        output_item_id: UInt16;
+        output_mass: UInt32;
+        inputs: recipe_input[];
+        stat_slots: stat_slot_response[];
+        blend_weights: Bytes;
+        output_item: recipe_item_info;
+        input_items: recipe_item_info[];
+    }
+    class recipes_result extends Struct {
+        recipes: recipe_response[];
+    }
+    class itemdata_result extends Struct {
+        items: item_def[];
+        recipes: recipes_result;
+    }
+    class items_info extends Struct {
+        items: item_def[];
+    }
+    class join extends Struct {
+        account: Name;
+    }
+    class location_static extends Struct {
+        coords: coordinates;
+        type: UInt8;
+        subtype: UInt8;
+        seed0: UInt8;
+        seed1: UInt8;
+    }
+    class location_derived extends Struct {
+        static_props: location_static;
+        size: UInt16;
+    }
+    class location_info extends Struct {
+        coords: coordinates;
+        is_system: boolean;
+    }
+    class module_info extends Struct {
+        id: UInt16;
+        mass: UInt32;
+        module_type: UInt8;
+        tier: UInt8;
+    }
+    class modules_result extends Struct {
+        modules: module_info[];
+    }
+    class nearby_system extends Struct {
+        distance: UInt64;
+        energy_cost: UInt64;
+        flight_time: UInt32;
+        location: location_info;
+    }
+    class nearby_info extends Struct {
+        can_travel: boolean;
+        current: entity_current_state;
+        projected: entity_current_state;
+        max_energy: UInt16;
+        systems: nearby_system[];
+    }
+    class schema_field extends Struct {
+        name: string;
+        field_type: string;
+    }
+    class nft_schema_def extends Struct {
+        schema_name: Name;
+        fields: schema_field[];
+    }
+    class nft_template_def extends Struct {
+        item_id: UInt16;
+        schema_name: Name;
+    }
+    class nftconfig_row extends Struct {
+        item_id: UInt16;
+        template_id: Int32;
+        schema_name: Name;
+    }
+    class nftinfo_result extends Struct {
+        schemas: nft_schema_def[];
+        templates: nft_template_def[];
+    }
+    class task_event extends Struct {
+        event_type: UInt8;
+        owner: Name;
+        entity_type: Name;
+        entity_id: UInt64;
+        task_index: UInt8;
+        task: task;
+        starts_at: TimePoint;
+        completes_at: TimePoint;
+        new_energy?: UInt16;
+    }
+    class notify extends Struct {
+        event: task_event;
+    }
+    class player_info extends Struct {
+        owner: Name;
+        is_player: boolean;
+        company_name: string;
+    }
+    class player_row extends Struct {
+        owner: Name;
+    }
+    class recharge extends Struct {
+        id: UInt64;
+    }
+    class refrshentity extends Struct {
+        entity_id: UInt64;
+    }
+    class reserve_row extends Struct {
+        id: UInt64;
+        coord_id: UInt64;
+        stratum: UInt16;
+        remaining: UInt32;
+    }
+    class resolve extends Struct {
+        id: UInt64;
+        count?: UInt64;
+    }
+    class resolve_results extends Struct {
+        entity_id: UInt64;
+        entity_type: Name;
+        resolved_count: UInt8;
+        new_schedule_started?: TimePoint;
+        entitygroup?: UInt64;
+        group_members?: entity_ref[];
+    }
+    class resource_info extends Struct {
+        id: UInt16;
+        mass: UInt32;
+        category: UInt8;
+        tier: UInt8;
+    }
+    class resource_stats extends Struct {
+        stat1: UInt16;
+        stat2: UInt16;
+        stat3: UInt16;
+    }
+    class resources_result extends Struct {
+        resources: resource_info[];
+    }
+    class rmmodule extends Struct {
+        entity_id: UInt64;
+        module_index: UInt8;
+        target_ref?: cargo_ref;
+    }
+    class rmnftcfg extends Struct {
+        item_id: UInt16;
+    }
+    class salt extends Struct {
+        salt: UInt64;
+    }
+    class setnftcfg extends Struct {
+        item_id: UInt16;
+        template_id: Int32;
+        schema_name: Name;
+    }
+    class skipreveal extends Struct {
+        commit: Checksum256;
+    }
+    class spawncargo extends Struct {
+        entity_id: UInt64;
+        item_id: UInt64;
+        quantity: UInt64;
+    }
+    class spawnpacked extends Struct {
+        entity_id: UInt64;
+        item_id: UInt16;
+        hull_stats: UInt64;
+        installed: packed_module[];
+    }
+    class spawnseeded extends Struct {
+        entity_id: UInt64;
+        item_id: UInt64;
+        quantity: UInt64;
+        stats: UInt64;
+    }
+    class state_row extends Struct {
+        enabled: boolean;
+        epoch: UInt32;
+        salt: UInt64;
+        seed: Checksum256;
+        commit: Checksum256;
+    }
+    class stratum_info extends Struct {
+        item_id: UInt16;
+        seed: UInt64;
+        richness: UInt16;
+        reserve: UInt32;
+        reserve_max: UInt32;
+    }
+    class stratum_data extends Struct {
+        stratum: stratum_info;
+        stats: resource_stats;
+    }
+    class stratum_remaining extends Struct {
+        stratum: UInt16;
+        remaining: UInt32;
+    }
+    class task_results extends Struct {
+        entities: entity_task_info[];
+    }
+    class transfer extends Struct {
+        source_id: UInt64;
+        dest_id: UInt64;
+        items: cargo_item[];
+    }
+    class travel extends Struct {
+        id: UInt64;
+        x: Int64;
+        y: Int64;
+        recharge: boolean;
+    }
+    class types_row extends Struct {
+        id: UInt64;
+        entity_summary_type: entity_summary;
+        game_config_type: game_config;
+        stratum_remaining_type: stratum_remaining;
+    }
+    class undeploy extends Struct {
+        host_id: UInt64;
+        target_id: UInt64;
+    }
+    class warp extends Struct {
+        id: UInt64;
+        x: Int64;
+        y: Int64;
+    }
+    class wipe extends Struct {
+    }
+    class wrap extends Struct {
+        owner: Name;
+        entity_id: UInt64;
+        nexus_id: UInt64;
+        items: cargo_item[];
+    }
+    class wrapentity extends Struct {
+        entity_id: UInt64;
+        nexus_id: UInt64;
+    }
+}
+
+type CoordinatesType = Coordinates | Types.coordinates | {
+    x: Int64Type;
+    y: Int64Type;
+};
+declare class Coordinates extends Types.coordinates {
+    static from(value: CoordinatesType): Coordinates;
+    equals(other: CoordinatesType): boolean;
+    toLocationId(): UInt64;
+}
+
+interface EntityCapabilities {
+    hullmass?: UInt32;
+    capacity?: UInt32;
+    engines?: Types.movement_stats;
+    generator?: Types.energy_stats;
+    loaders?: Types.loader_stats;
+    gatherer?: Types.gatherer_stats;
+    crafter?: Types.crafter_stats;
+    hauler?: Types.hauler_stats;
+}
+interface EntityState {
+    owner: Name;
+    location: Types.coordinates;
+    energy?: UInt16;
+    cargomass: UInt32;
+    cargo: Types.cargo_item[];
+}
+
+interface CargoStack {
+    item_id: UInt16;
+    quantity: UInt32;
+    stats: UInt64;
+    modules: Types.module_entry[];
+}
+
+interface ProjectedEntity {
+    location: Coordinates;
+    energy: UInt16;
+    cargo: CargoStack[];
+    shipMass: UInt32;
+    capacity?: UInt64;
+    engines?: Types.movement_stats;
+    loaders?: Types.loader_stats;
+    generator?: Types.energy_stats;
+    hauler?: Types.hauler_stats;
+    readonly cargoMass: UInt64;
+    readonly totalMass: UInt64;
+    hasMovement(): boolean;
+    hasStorage(): boolean;
+    hasLoaders(): boolean;
+    capabilities(): EntityCapabilities;
+    state(): EntityState;
+}
+
+interface ContractProjectedState {
+    owner: {
+        toString(): string;
+    };
+    coordinates: Types.coordinates;
+    energy?: UInt16;
+    cargomass: UInt32;
+    cargo: Types.cargo_view[];
+    hullmass?: UInt32;
+    capacity?: UInt32;
+    engines?: Types.movement_stats;
+    loaders?: Types.loader_stats;
+    generator?: Types.energy_stats;
+    hauler?: Types.hauler_stats;
+}
+interface ProjectionComparisonOptions {
+    step?: number;
+}
+declare function assertProjectionEquals(contract: ContractProjectedState, sdk: ProjectedEntity, options?: ProjectionComparisonOptions): void;
+
+export { CATALOG_FILES_REL, ContractProjectedState, ProjectionComparisonOptions, assertProjectionEquals, computeCatalogHash };