@projectsophon/types v0.1.3

@projectsophon/types

This package contains commonly-used data types in the Dark Forest webclient, also accessible in node.js server environments.

Installation

You can install this package using npm or yarn by running:

npm install --save @projectsophon/types

yarn add @projectsophon/types

When using this in a plugin, you might want to load it with skypack

import * as types from 'http://cdn.skypack.dev/@projectsophon/types'

Table of contents

Classes

• DFAnimation
• DFStatefulAnimation

Interfaces

• ArrivalWithTimer
• AsteroidRendererType
• BackgroundRendererType
• BaseRenderer
• BeltRendererType
• BlackDomainRendererType
• CanvasCoords
• CaptureZoneRendererType
• Chunk
• CircleRendererType
• DeleteMessagesRequest
• DiagnosticUpdater
• Diagnostics
• EmojiFlagBody
• GameViewport
• GasPrices
• IRendererConfig
• Leaderboard
• LeaderboardEntry
• LineRendererType
• MineBodyRendererType
• MineRendererType
• ModalPosition
• NetworkEvent
• PerlinConfig
• PerlinRendererType
• PersistedTransaction
• PlanetCosmeticInfo
• PlanetDefaults
• PlanetMessage
• PlanetMessageRequest
• PlanetMessageResponse
• PlanetRenderInfo
• PlanetRenderManagerType
• PlanetRendererType
• PostMessageRequest
• QuasarBodyRendererType
• QuasarRayRendererType
• QuasarRendererType
• QueuedArrival
• Radii
• RectRendererType
• Rectangle
• RenderedArtifact
• RingRendererType
• RuinsRendererType
• SignedMessage
• SpaceRendererType
• SpacetimeRipRendererType
• SpriteRendererType
• TextRendererType
• Transaction
• TransactionCollection
• UIRendererType
• UnminedRendererType
• VoyageRendererType
• WormholeRendererType

Other Type Aliases

• ArrivalType
• Artifact
• ArtifactId
• ArtifactPointValues
• ArtifactRarity
• ArtifactType
• AttribProps
• AttribType
• AutoGasSetting
• Biome
• CaptureZone
• ClaimedCoords
• ClaimedLocation
• ContractMethodName
• CursorState
• DrawMode
• EthAddress
• EthTxStatus
• HSLVec
• HatType
• LocatablePlanet
• LocationId
• ModalId
• ModalManagerEvent
• ModalName
• ModalPositions
• NFTMetadata
• NetworkHealthSummary
• Planet
• PlanetBonus
• PlanetLevel
• PlanetMessageBody
• PlanetMessageType
• PlanetType
• Player
• PluginId
• RGBAVec
• RGBVec
• RegisterResponse
• RenderZIndex
• RendererProgram
• RendererType
• RevealedCoords
• RevealedLocation
• RuinsInfo
• Scaling
• Setting
• SpaceColorConfiguration
• SpaceType
• TextAlign
• TextAnchor
• TooltipName
• TransactionId
• Translation
• UniformJSType
• UniformProps
• UniformType
• Upgrade
• UpgradeBranchName
• UpgradeBranches
• UpgradeLevels
• UpgradeState
• Vec3
• VoyageId
• WhitelistStatusResponse
• WorldCoords
• WorldLocation
• Wormhole

Type Type Aliases

• Abstract

Variables

• ArrivalType
• ArtifactRarity
• ArtifactRarityNames
• ArtifactType
• ArtifactTypeNames
• AttribType
• AutoGasSetting
• Biome
• BiomeNames
• CursorState
• DrawMode
• HatType
• ModalManagerEvent
• ModalName
• PlanetLevel
• PlanetLevelNames
• PlanetMessageType
• PlanetType
• PlanetTypeNames
• RenderZIndex
• RendererType
• Setting
• SpaceType
• SpaceTypeNames
• TextAlign
• TextAnchor
• TooltipName
• UniformType
• UpgradeBranchName

Functions

• artifactNameFromArtifact

Other Type Aliases

ArrivalType

Ƭ ArrivalType: Abstract<number, "ArrivalType">

Abstract type representing an arrival type.

Artifact

Ƭ Artifact: Object

Represents data associated with a Dark Forest artifact NFT. Note that some Artifact fields store client-specific data that the blockchain is not aware of, such as unconfirmedDepositArtifact (tracks pending depositArtifact transaction that involves this artifact). If you're using a client that can't send transactions, these fields should be ignored.

Type declaration

ArtifactId

Ƭ ArtifactId: Abstract<string, "ArtifactId">

A unique identifier for a Dark Forest NFT artifact. This is a 64-character lowercase hex string not prefixed with 0x. ArtifactIDs should only be instantiated through ArtifactIDs should only be instantiated through artifactIdFromHexStr, artifactIdFromDecStr, and artifactIdFromEthersBN in serde.

ArtifactPointValues

Ƭ ArtifactPointValues: Object

mapping from ArtifactRarity to points earned for finding this artifact.

Index signature

▪ ArtifactRarity: number: number

ArtifactRarity

Ƭ ArtifactRarity: Abstract<number, "ArtifactRarity">

Abstract type representing an artifact rarity level.

ArtifactType

Ƭ ArtifactType: Abstract<number, "ArtifactType">

Abstract type representing an artifact type.

AttribProps

Ƭ AttribProps: Object

Type declaration

AttribType

Ƭ AttribType: Abstract<number, "AttribType">

AutoGasSetting

Ƭ AutoGasSetting: Abstract<string, "AutoGasSetting">

The user can choose to have the client automatically choose a gas price for their transactions, depending on how much they are willing to pay and how fast they want their transactions to confirm.

Biome

Ƭ Biome: Abstract<number, "Biome">

Abstract type representing a biome.

CaptureZone

Ƭ CaptureZone: Object

Type declaration

ClaimedCoords

Ƭ ClaimedCoords: WorldCoords & { hash: LocationId ; revealer: EthAddress ; score: number }

Represents a planet location that has been broadcast on-chain

ClaimedLocation

Ƭ ClaimedLocation: WorldLocation & { revealer: EthAddress }

ContractMethodName

Ƭ ContractMethodName: "revealLocation" | "initializePlayer" | "move" | "upgradePlanet" | "buyHat" | "transferPlanet" | "findArtifact" | "prospectPlanet" | "depositArtifact" | "withdrawArtifact" | "activateArtifact" | "deactivateArtifact" | "withdrawSilver" | "useKey" | "adminUseKey" | "addKeys" | "giveSpaceShips" | "createLobby" | "invadePlanet" | "capturePlanet"

CursorState

Ƭ CursorState: Abstract<string, "CursorState">

DrawMode

Ƭ DrawMode: Abstract<number, "DrawMode">

EthAddress

Ƭ EthAddress: Abstract<string, "EthAddress">

This is expected to be a 40-character, lowercase hex string, prefixed with 0x (so 42 characters in total). EthAddress should only ever be instantiated through the address function in serde.

EthTxStatus

Ƭ EthTxStatus: "Init" | "Processing" | "Prioritized" | "Submit" | "Confirm" | "Fail" | "Cancel"

HSLVec

Ƭ HSLVec: readonly number, number, number

HatType

Ƭ HatType: Abstract<string, "HatType">

LocatablePlanet

Ƭ LocatablePlanet: Planet & { biome: Biome ; location: WorldLocation }

A planet whose coordinates are known to the client.

LocationId

Ƭ LocationId: Abstract<string, "LocationId">

a unique identifier for a location in the universe (corresponding to some underlying coordinates (x, y)). This is a 64-character lowercase hex string not prefixed with 0x. LocationIDs should only be instantiated through locationIdFromHexStr, locationIdFromDecStr, locationIdFromBigInt, and locationIdFromEthersBN in serde.

ModalId

Ƭ ModalId: ModalName | PluginId

Modals can either be built into the game, or spawned by a plugin.

ModalManagerEvent

Ƭ ModalManagerEvent: Abstract<string, "ModalManagerEvent">

ModalName

Ƭ ModalName: Abstract<string, "ModalName">

Modals built into the game have a human-readable name.

ModalPositions

Ƭ ModalPositions: Map<ModalId, ModalPosition>

NFTMetadata

Ƭ NFTMetadata: Object

Type declaration

NetworkHealthSummary

Ƭ NetworkHealthSummary: [AutoGasSetting, number][]

On the server we keep track of how fast each auto gas setting confirms in practice.

Planet

Ƭ Planet: Object

Represents a Dark Forest planet object (planets, asteroid fields, quasars, spacetime rips, and foundries). Note that some Planet fields (1) store client-specific data that the blockchain is not aware of, such as unconfirmedDepartures (tracks pending moves originating at this planet that have been submitted to the blockchain from a client), or (2) store derived data that is calculated separately client-side, such as silverSpent and bonus. So this object does not cleanly map to any single object in the DarkForest contract (or even any collection of objects).

Type declaration

PlanetBonus

Ƭ PlanetBonus: boolean, boolean, boolean, boolean, boolean, boolean

A list of five flags, indicating whether the planet has an attached comet doubling each of five stats: (in order) energyCap, energyGrowth, range, speed, defense

PlanetLevel

Ƭ PlanetLevel: Abstract<number, "PlanetLevel">

Abstract type representing a planet level.

PlanetMessageBody

Ƭ PlanetMessageBody: EmojiFlagBody | unknown

Thinking about future message types.

PlanetMessageType

Ƭ PlanetMessageType: Abstract<string, "PlanetMessageType">

Abstract type representing a type of planet message.

PlanetType

Ƭ PlanetType: Abstract<number, "PlanetType">

Abstract type representing a planet type.

Player

Ƭ Player: Object

Represents a player; corresponds fairly closely with the analogous contract struct

Type declaration

PluginId

Ƭ PluginId: Abstract<string, "PluginId">

RGBAVec

Ƭ RGBAVec: number, number, number, number

RGBVec

Ƭ RGBVec: number, number, number

RegisterResponse

Ƭ RegisterResponse: Object

Type declaration

RenderZIndex

Ƭ RenderZIndex: Abstract<number, "RenderZIndex">

RendererProgram

Ƭ RendererProgram: Object

Type declaration

RendererType

Ƭ RendererType: Abstract<number, "RendererType">

Enum for determining the type of renderer Each renderer should contain a variable called 'rendererType' 'rendererType' should be a enum that corresponds with the type of renderer it is

RevealedCoords

Ƭ RevealedCoords: WorldCoords & { hash: LocationId ; revealer: EthAddress }

Represents a planet location that has been broadcast on-chain

RevealedLocation

Ƭ RevealedLocation: WorldLocation & { revealer: EthAddress }

RuinsInfo

Ƭ RuinsInfo: Object

Index signature

▪ PlanetLevel: number: { props: number, number, number, number ; weights: number, number, number, number }

Scaling

Ƭ Scaling: Object

Type declaration

Setting

Ƭ Setting: Abstract<string, "Setting">

SpaceColorConfiguration

Ƭ SpaceColorConfiguration: Object

Type declaration

SpaceType

Ƭ SpaceType: Abstract<number, "SpaceType">

Abstract type representing a type of space.

TextAlign

Ƭ TextAlign: Abstract<number, "TextAlign">

TextAnchor

Ƭ TextAnchor: Abstract<number, "TextAnchor">

TooltipName

Ƭ TooltipName: Abstract<string, "TooltipName">

TransactionId

Ƭ TransactionId: number

A unique incrementing number that identifies a transaction.

Translation

Ƭ Translation: Object

Type declaration

UniformJSType

Ƭ UniformJSType: mat4 | mat3 | number | Vec3

UniformProps

Ƭ UniformProps: Object

Type declaration

UniformType

Ƭ UniformType: Abstract<number, "UniformType">

Upgrade

Ƭ Upgrade: Object

The effects of an upgrade on the stats of a planet. Both upgrades purchased for silver as well as artifacts of certain types can modify stats of a planet.

Type declaration

UpgradeBranchName

Ƭ UpgradeBranchName: Abstract<number, "UpgradeBranchName">

Abstract type representing an upgrade branch.

UpgradeBranches

Ƭ UpgradeBranches: [UpgradeLevels, UpgradeLevels, UpgradeLevels]

Stores the stat effects of upgrades of all three branches: defense, range, speed.

UpgradeLevels

Ƭ UpgradeLevels: [Upgrade, Upgrade, Upgrade, Upgrade]

On a single upgrade branch, the stat effects of the four upgrades.

UpgradeState

Ƭ UpgradeState: number, number, number

How many times a planet has been upgraded along each of the three branches: defense, range, and speed

Vec3

Ƭ Vec3: number, number, number

VoyageId

Ƭ VoyageId: Abstract<string, "VoyageId">

a voyage UID. these start at 1 and auto-increment in the contract. this is immutable and the only place a VoyageId should ever be created is on initial deserialization of a QueuedArrival from contract data (see serde)

WhitelistStatusResponse

Ƭ WhitelistStatusResponse: Object

Type declaration

WorldCoords

Ƭ WorldCoords: Object

Represents the coordinates of a location in the world.

Type declaration

WorldLocation

Ƭ WorldLocation: Object

A location in the world with relevant properties: the location's ID (deterministically generated from its coords), the spacetype perlin value at these coordinates, and the biomebase perlin value at these coordinates (combined with spacetype to derive the biome here)

Type declaration

Wormhole

Ƭ Wormhole: Object

Type declaration

Type Type Aliases

Abstract

Ƭ Abstract<Type, Token>: Type & Tagged<Token>

Create an opaque type, which hides its internal details from the public, and can only be created by being used explicitly.

The generic type parameter can be anything. It doesn't have to be an object.

Read more about opaque types.

There have been several discussions about adding this feature to TypeScript via the opaque type operator, similar to how Flow does it. Unfortunately, nothing has (yet) moved forward: - Microsoft/TypeScript#202 - Microsoft/TypeScript#15408 - Microsoft/TypeScript#15807

Example

import type {Opaque} from 'type-fest';

type AccountNumber = Opaque<number, 'AccountNumber'>;
type AccountBalance = Opaque<number, 'AccountBalance'>;

// The `Token` parameter allows the compiler to differentiate between types, whereas "unknown" will not. For example, consider the following structures:
type ThingOne = Opaque<string>;
type ThingTwo = Opaque<string>;

// To the compiler, these types are allowed to be cast to each other as they have the same underlying type. They are both `string & { __opaque__: unknown }`.
// To avoid this behaviour, you would instead pass the "Token" parameter, like so.
type NewThingOne = Opaque<string, 'ThingOne'>;
type NewThingTwo = Opaque<string, 'ThingTwo'>;

// Now they're completely separate types, so the following will fail to compile.
function createNewThingOne (): NewThingOne {
	// As you can see, casting from a string is still allowed. However, you may not cast NewThingOne to NewThingTwo, and vice versa.
	return 'new thing one' as NewThingOne;
}

// This will fail to compile, as they are fundamentally different types.
const thingTwo = createNewThingOne() as NewThingTwo;

// Here's another example of opaque typing.
function createAccountNumber(): AccountNumber {
	return 2 as AccountNumber;
}

function getMoneyForAccount(accountNumber: AccountNumber): AccountBalance {
	return 4 as AccountBalance;
}

// This will compile successfully.
getMoneyForAccount(createAccountNumber());

// But this won't, because it has to be explicitly passed as an `AccountNumber` type.
getMoneyForAccount(2);

// You can use opaque values like they aren't opaque too.
const accountNumber = createAccountNumber();

// This will not compile successfully.
const newAccountNumber = accountNumber + 2;

// As a side note, you can (and should) use recursive types for your opaque types to make them stronger and hopefully easier to type.
type Person = {
	id: Opaque<number, Person>;
	name: string;
};

Type parameters

Variables

ArrivalType

• ArrivalType: Object

Enumeration of arrival types.

Type declaration

ArtifactRarity

• ArtifactRarity: Object

Enumeration of artifact rarity levels. Common = 1, Mythic = 5

Type declaration

ArtifactRarityNames

• Const ArtifactRarityNames: Object

Mapping from ArtifactRarity to pretty-printed names.

ArtifactType

• ArtifactType: Object

Enumeration of artifact types.

Type declaration

ArtifactTypeNames

• Const ArtifactTypeNames: Object

Mapping from ArtifactType to pretty-printed names.

AttribType

• AttribType: Object

Type declaration

AutoGasSetting

• AutoGasSetting: Object

Type declaration

Biome

• Biome: Object

Enumeration of the biomes in the game. OCEAN = 1, CORRUPTED = 10

Type declaration

BiomeNames

• Const BiomeNames: Object

Mapping from Biome to pretty-printed names.

CursorState

• CursorState: Object

Type declaration

DrawMode

• DrawMode: Object

Type declaration

HatType

• HatType: Object

Type declaration

ModalManagerEvent

• ModalManagerEvent: Object

Type declaration

ModalName

• ModalName: Object

Type declaration

PlanetLevel

• PlanetLevel: Object

Enumeration of the possible planet levels.

Type declaration

PlanetLevelNames

• Const PlanetLevelNames: Object

Mapping from PlanetLevel to pretty-printed names.

PlanetMessageType

• PlanetMessageType: Object

Each message type has a corresponding entry here.

Type declaration

PlanetType

• PlanetType: Object

Enumeration of the planet types. (PLANET = 0, SILVER_BANK = 4)

Type declaration

PlanetTypeNames

• Const PlanetTypeNames: Object

Mapping from PlanetType to pretty-printed names.

RenderZIndex

• RenderZIndex: Object

Type declaration

RendererType

• RendererType: Object

Type declaration

Setting

• Setting: Object

Each setting has a unique identifier. Each account gets to store its own local storage setting, per instance of the dark forest contract that it's connected to.

Type declaration

SpaceType

• SpaceType: Object

Enumeration of the types of space in the game. NEBULA = 0, DEAD_SPACE = 3

Type declaration

SpaceTypeNames

• Const SpaceTypeNames: Object

Mapping from SpaceType to pretty-printed names.

TextAlign

• TextAlign: Object

Type declaration

TextAnchor

• TextAnchor: Object

Type declaration

TooltipName

• TooltipName: Object

Type declaration

UniformType

• UniformType: Object

Type declaration

UpgradeBranchName

• UpgradeBranchName: Object

Enumeration of the three upgrade branches.

Type declaration

Functions

artifactNameFromArtifact

▸ artifactNameFromArtifact(artifact): string

Deterministically generates the name of the artifact from its ID.

Parameters

Returns

string