Skip to content

Latest commit

 

History

History
3177 lines (1877 loc) · 78 KB

Backend_GameLogic_GameManager.default.md

File metadata and controls

3177 lines (1877 loc) · 78 KB
Raw

Class: default

Backend/GameLogic/GameManager.default

Hierarchy

  • EventEmitter

    ↳ default

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

• Private new default(terminal, account, players, touchedPlanets, allTouchedPlanetIds, revealedCoords, claimedCoords, worldRadius, unprocessedArrivals, unprocessedPlanetArrivalIds, contractsAPI, contractConstants, persistentChunkStore, snarkHelper, homeLocation, useMockHash, artifacts, ethConnection, paused)

Parameters

Name Type
terminal MutableRefObject<undefined | TerminalHandle>
account undefined | EthAddress
players Map<string, Player>
touchedPlanets Map<LocationId, Planet>
allTouchedPlanetIds Set<LocationId>
revealedCoords Map<LocationId, RevealedCoords>
claimedCoords Map<LocationId, ClaimedCoords>
worldRadius number
unprocessedArrivals Map<VoyageId, QueuedArrival>
unprocessedPlanetArrivalIds Map<LocationId, VoyageId[]>
contractsAPI ContractsAPI
contractConstants ContractConstants
persistentChunkStore default
snarkHelper default
homeLocation undefined | WorldLocation
useMockHash boolean
artifacts Map<ArtifactId, Artifact>
ethConnection EthConnection
paused boolean

Overrides

EventEmitter.constructor

Properties

account

• Private Readonly account: undefined | EthAddress

The ethereum address of the player who is currently logged in. We support 'no account', represented by undefined in the case when you want to simply load the game state from the contract and view it without be able to make any moves.

captureZoneGenerator

• Private captureZoneGenerator: undefined | CaptureZoneGenerator

Generates capture zones.

contractConstants

• Private Readonly contractConstants: ContractConstants

Game parameters set by the contract. Stuff like perlin keys, which are important for mining the correct universe, or the time multiplier, which allows us to tune how quickly voyages go.

todo move this into a separate GameConfiguration class.

contractsAPI

• Private Readonly contractsAPI: ContractsAPI

Allows us to make contract calls, and execute transactions. Be careful about how you use this guy. You don't want to cause your client to send an excessive amount of traffic to whatever node you're connected to.

Interacting with the blockchain isn't free, and we need to be mindful about about the way our application interacts with the blockchain. The current rate limiting strategy consists of three points:

  • data that needs to be fetched often should be fetched in bulk.
  • rate limit smart contract calls (reads from the blockchain), implemented by {@link ContractCaller} and transactions (writes to the blockchain on behalf of the player), implemented by {@link TxExecutor} via two separately tuned {@link ThrottledConcurrentQueue}s.

diagnostics

• Private diagnostics: Diagnostics

Diagnostic information about the game.

diagnosticsInterval

• Private diagnosticsInterval: Timer

Handle to an interval that periodically uploads diagnostic information from this client.

endTimeSeconds

• Private Readonly endTimeSeconds: number = 1948939200

todo change this to the correct timestamp each round.

entityStore

• Private Readonly entityStore: GameObjects

This variable contains the internal state of objects that live in the game world.

ethConnection

• Private Readonly ethConnection: EthConnection

An interface to the blockchain that is a little bit lower-level than ContractsAPI. It allows us to do basic operations such as wait for a transaction to complete, check the player's address and balance, etc.

hashConfig

• Private Readonly hashConfig: HashConfig

Each round we change the hash configuration of the game. The hash configuration is download from the blockchain, and essentially acts as a salt, permuting the universe into a unique configuration for each new round.

todo deduplicate this and useMockHash somehow.

hashRate

• Private hashRate: number

Continuously updated value representing the total hashes per second that the game is currently mining the universe at.

todo keep this in {@link MinerManager}

homeLocation

• Private homeLocation: undefined | WorldLocation

The spawn location of the current player.

todo, make this smarter somehow. It's really annoying to have to import world coordinates, and get them wrong or something. Maybe we need to mark a planet, once it's been initialized contract-side, as the homeworld of the user who initialized on it. That way, when you import a new account into the game, and you import map data that contains your home planet, the client would be able to automatically detect which planet is the player's home planet.

todo move this into a new PlayerState class.

minerManager

• Private Optional minerManager: default

Manages the process of mining new space territory.

networkHealth$

• networkHealth$: Monomitter<NetworkHealthSummary>

Emits whenever we load the network health summary from the webserver, which is derived from diagnostics that the client sends up to the webserver as well.

networkHealthInterval

• Private networkHealthInterval: Timer

Handle to an interval that periodically refreshes the network's health from our webserver.

paused

• Private paused: boolean

paused$

• paused$: Monomitter<boolean>

persistentChunkStore

• Private Readonly persistentChunkStore: default

An object that syncs any newly added or deleted chunks to the player's IndexedDB.

todo it also persists other game data to IndexedDB. This class needs to be renamed GameSaver or something like that.

planetHashMimc

• Private Readonly planetHashMimc: (...inputs: number[]) => BigInteger

Type declaration

▸ (...inputs): BigInteger

The aforementioned hash function. In debug mode where DISABLE_ZK_CHECKS is on, we use a faster hash function. Othewise, in production mode, use MiMC hash (https://byt3bit.github.io/primesym/).

Parameters
Name Type
...inputs number[]
Returns

BigInteger

playerInterval

• Private playerInterval: Timer

Handle to an interval that periodically refreshes some information about the player from the blockchain.

todo move this into a new PlayerState class.

players

• Private Readonly players: Map<string, Player>

Map from ethereum addresses to player objects. This isn't stored in GameObjects, because it's not techincally an entity that exists in the world. A player just controls planets and artifacts that do exist in the world.

todo move this into a new Players class.

playersUpdated$

• Readonly playersUpdated$: Monomitter<void>

Whenever we refresh the players twitter accounts or scores, we publish an event here.

safeMode

• Private safeMode: boolean

Setting to allow players to start game without plugins that were running during the previous run of the game client. By default, the game launches plugins that were running that were running when the game was last closed.

scoreboardInterval

• Private scoreboardInterval: Timer

Handle to an interval that periodically refreshes the scoreboard from our webserver.

settingsSubscription

• Private settingsSubscription: undefined | Subscription

Subscription to act on setting changes

snarkHelper

• Private Readonly snarkHelper: default

Responsible for generating snark proofs.

terminal

• Private Readonly terminal: MutableRefObject<undefined | TerminalHandle>

Kind of hacky, but we store a reference to the terminal that the player sees when the initially load into the game. This is the same exact terminal that appears inside the collapsable right bar of the game.

useMockHash

• Private Readonly useMockHash: boolean

In debug builds of the game, we can connect to a set of contracts deployed to a local blockchain, which are tweaked to not verify planet hashes, meaning we can use a faster hash function with similar properties to mimc. This allows us to mine the map faster in debug mode.

todo move this into a separate GameConfiguration class.

worldRadius

• Private worldRadius: number

Sometimes the universe gets bigger... Sometimes it doesn't.

todo move this into a new GameConfiguration class.

Accessors

captureZoneGeneratedEmitter

• get captureZoneGeneratedEmitter(): undefined | Monomitter<CaptureZonesGeneratedEvent>

Emits when new capture zones are generated.

Returns

undefined | Monomitter<CaptureZonesGeneratedEvent>

planetRarity

• get planetRarity(): number

Returns

number

Methods

activateArtifact

▸ activateArtifact(locationId, artifactId, wormholeTo, bypassChecks?): Promise<Transaction<UnconfirmedActivateArtifact>>

Parameters

Name Type Default value
locationId LocationId undefined
artifactId ArtifactId undefined
wormholeTo undefined | LocationId undefined
bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedActivateArtifact>>

addAccount

▸ addAccount(coords): Promise<boolean>

Initializes a new player's game to start at the given home planet. Must have already initialized the player on the contract.

Parameters

Name Type
coords WorldCoords

Returns

Promise<boolean>

addNewChunk

▸ addNewChunk(chunk): default

Makes this game manager aware of a new chunk - which includes its location, size, as well as all of the planets contained in that chunk. Causes the client to load all of the information about those planets from the blockchain.

Parameters

Name Type
chunk Chunk

Returns

default

biomebasePerlin

▸ biomebasePerlin(coords, floor): number

Gets the biome perlin valie at the given location in the world.

Parameters

Name Type
coords WorldCoords
floor boolean

Returns

number

bulkAddNewChunks

▸ bulkAddNewChunks(chunks): Promise<void>

To add multiple chunks at once, use this function rather than addNewChunk, in order to load all of the associated planet data in an efficient manner.

Parameters

Name Type
chunks Chunk[]

Returns

Promise<void>

bulkHardRefreshPlanets

▸ Private bulkHardRefreshPlanets(planetIds): Promise<void>

Parameters

Name Type
planetIds LocationId[]

Returns

Promise<void>

buyHat

▸ buyHat(planetId, _bypassChecks?): Promise<Transaction<UnconfirmedBuyHat>>

Submits a transaction to the blockchain to buy a hat for the given planet. You must own the planet. Warning costs real xdai. Hats are permanently locked to a planet. They are purely cosmetic and a great way to BM your opponents or just look your best. Just like in the real world, more money means more hat.

Parameters

Name Type Default value
planetId LocationId undefined
_bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedBuyHat>>

capturePlanet

▸ capturePlanet(locationId): Promise<Transaction<UnconfirmedCapturePlanet>>

Parameters

Name Type
locationId LocationId

Returns

Promise<Transaction<UnconfirmedCapturePlanet>>

checkGameHasEnded

▸ Private checkGameHasEnded(): boolean

Returns

boolean

clearEmoji

▸ clearEmoji(locationId): Promise<void>

If you are the owner of this planet, you can delete the emoji that is hovering above the planet.

Parameters

Name Type
locationId LocationId

Returns

Promise<void>

deactivateArtifact

▸ deactivateArtifact(locationId, artifactId, bypassChecks?): Promise<Transaction<UnconfirmedDeactivateArtifact>>

Parameters

Name Type Default value
locationId LocationId undefined
artifactId ArtifactId undefined
bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedDeactivateArtifact>>

depositArtifact

▸ depositArtifact(locationId, artifactId): Promise<Transaction<UnconfirmedDepositArtifact>>

Submits a transaction to the blockchain to deposit an artifact on a given planet. You must own the planet and you must own the artifact directly (can't be locked in contract)

Parameters

Name Type
locationId LocationId
artifactId ArtifactId

Returns

Promise<Transaction<UnconfirmedDepositArtifact>>

destroy

▸ destroy(): void

Returns

void

findArtifact

▸ findArtifact(planetId, bypassChecks?): Promise<Transaction<UnconfirmedFindArtifact>>

Calls the contract to find an artifact on the given planet.

Parameters

Name Type Default value
planetId LocationId undefined
bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedFindArtifact>>

findRandomHomePlanet

▸ Private findRandomHomePlanet(): Promise<LocatablePlanet>

Returns

Promise<LocatablePlanet>

forceTick

▸ forceTick(locationId): void

Parameters

Name Type
locationId LocationId

Returns

void

getAccount

▸ getAccount(): undefined | EthAddress

Gets the address of the player logged into this game manager.

Returns

undefined | EthAddress

getActiveArtifact

▸ getActiveArtifact(planet): undefined | Artifact

Gets the active artifact on this planet, if one exists.

Parameters

Name Type
planet Planet

Returns

undefined | Artifact

getAddress

▸ getAddress(): undefined | EthAddress

Returns

undefined | EthAddress

getAllOwnedPlanets

▸ getAllOwnedPlanets(): Planet[]

Gets a list of planets that have an owner.

Returns

Planet[]

getAllPlanets

▸ getAllPlanets(): Iterable<Planet>

Gets all planets. This means all planets that are in the contract, and also all planets that have been mined locally. Does not update planets if they are stale. NOT PERFORMANT - for scripting only.

Returns

Iterable<Planet>

getAllPlayers

▸ getAllPlayers(): Player[]

Gets a list of all the players in the game (not just the ones you've encounterd)

Returns

Player[]

getAllVoyages

▸ getAllVoyages(): QueuedArrival[]

Gets all voyages that have not completed.

Returns

QueuedArrival[]

getArtifactMap

▸ getArtifactMap(): Map<ArtifactId, Artifact>

Return a reference to the artifact map

Returns

Map<ArtifactId, Artifact>

getArtifactUpdated$

▸ getArtifactUpdated$(): Monomitter<ArtifactId>

Returns

Monomitter<ArtifactId>

getArtifactWithId

▸ getArtifactWithId(artifactId?): undefined | Artifact

Gets the artifact with the given id. Null if no artifact with id exists.

Parameters

Name Type
artifactId? ArtifactId

Returns

undefined | Artifact

getArtifactsWithIds

▸ getArtifactsWithIds(artifactIds?): (undefined | Artifact)[]

Gets the artifacts with the given ids, including ones we know exist but haven't been loaded, represented by undefined.

Parameters

Name Type Default value
artifactIds ArtifactId[] []

Returns

(undefined | Artifact)[]

getCaptureZoneGenerator

▸ getCaptureZoneGenerator(): undefined | CaptureZoneGenerator

Returns

undefined | CaptureZoneGenerator

getCaptureZones

▸ getCaptureZones(): Set<CaptureZone>

Returns

Set<CaptureZone>

getChunk

▸ getChunk(chunkFootprint): undefined | Chunk

Parameters

Name Type
chunkFootprint Rectangle

Returns

undefined | Chunk

getChunkStore

▸ getChunkStore(): default

Returns

default

getClaimedLocations

▸ getClaimedLocations(): Map<LocationId, ClaimedLocation>

Gets a map of all location IDs which have been claimed.

Returns

Map<LocationId, ClaimedLocation>

getConstructors

▸ getConstructors(): Object

Returns constructors of classes that may be useful for developing plugins.

Returns

Object

Name Type
MinerManager typeof default
SpiralPattern typeof SpiralPattern
SwissCheesePattern typeof SwissCheesePattern
TowardsCenterPattern typeof TowardsCenterPattern
TowardsCenterPatternV2 typeof TowardsCenterPatternV2

getContract

▸ getContract(): DarkForest

Returns

DarkForest

getContractAPI

▸ getContractAPI(): ContractsAPI

Get the thing that handles contract interaction.

Returns

ContractsAPI

getContractAddress

▸ getContractAddress(): EthAddress

Gets the address of the DarkForest contract, which is the 'backend' of the game.

Returns

EthAddress

getContractConstants

▸ getContractConstants(): ContractConstants

Returns

ContractConstants

getCurrentlyExploringChunk

▸ getCurrentlyExploringChunk(): undefined | Rectangle

Gets the rectangle bounding the chunk that the miner is currently in the process of hashing.

Returns

undefined | Rectangle

getDefaultSpaceJunkForPlanetLevel

▸ getDefaultSpaceJunkForPlanetLevel(level): number

Parameters

Name Type
level number

Returns

number

getDiagnostics

▸ getDiagnostics(): Diagnostics

Gets some diagnostic information about the game. Returns a copy, you can't modify it.

Returns

Diagnostics

getDist

▸ getDist(fromId, toId): number

Gets the distance between two planets. Throws an exception if you don't know the location of either planet. Takes into account wormholes.

Parameters

Name Type
fromId LocationId
toId LocationId

Returns

number

getDistCoords

▸ getDistCoords(fromCoords, toCoords): number

Gets the distance between two coordinates in space.

Parameters

Name Type
fromCoords WorldCoords
toCoords WorldCoords

Returns

number

getEndTimeSeconds

▸ getEndTimeSeconds(): number

The game ends at a particular time in the future - get this time measured in seconds from the epoch.

Returns

number

getEnergyArrivingForMove

▸ getEnergyArrivingForMove(fromId, toId, distance, sentEnergy, abandoning): number

Gets the amount of energy that would arrive if a voyage with the given parameters was to occur. The toPlanet is optional, in case you want an estimate that doesn't include wormhole speedups.

Parameters

Name Type
fromId LocationId
toId undefined | LocationId
distance undefined | number
sentEnergy number
abandoning boolean

Returns

number

getEnergyCurveAtPercent

▸ getEnergyCurveAtPercent(planet, percent): number

returns timestamp (seconds) that planet will reach percent% of energycap time may be in the past

Parameters

Name Type
planet Planet
percent number

Returns

number

getEnergyNeededForMove

▸ getEnergyNeededForMove(fromId, toId, arrivingEnergy, abandoning?): number

Gets the amount of energy needed in order for a voyage from the given to the given planet to arrive with your desired amount of energy.

Parameters

Name Type Default value
fromId LocationId undefined
toId LocationId undefined
arrivingEnergy number undefined
abandoning boolean false

Returns

number

getEnergyOfPlayer

▸ getEnergyOfPlayer(player): number

Gets the total amount of energy that lives on planets that the given player owns.

Parameters

Name Type
player EthAddress

Returns

number

getEthConnection

▸ getEthConnection(): EthConnection

Returns

EthConnection

getExploredChunks

▸ getExploredChunks(): Iterable<Chunk>

Gets all the map chunks that this client is aware of. Chunks may have come from mining, or from importing map data.

Returns

Iterable<Chunk>

getGameObjects

▸ getGameObjects(): GameObjects

Gets a reference to the game's internal representation of the world state. This includes voyages, planets, artifacts, and active wormholes,

Returns

GameObjects

getHashConfig

▸ getHashConfig(): HashConfig

Gets the HASH CONFIG

Returns

HashConfig

getHashesPerSec

▸ getHashesPerSec(): number

Gets the amount of hashes per second that the miner manager is calculating.

Returns

number

getHomeCoords

▸ getHomeCoords(): undefined | WorldCoords

Gets the location of your home planet.

Returns

undefined | WorldCoords

getHomeHash

▸ getHomeHash(): undefined | LocationId

Gets the hash of the location of your home planet.

Returns

undefined | LocationId

getLocationOfPlanet

▸ getLocationOfPlanet(planetId): undefined | WorldLocation

Gets the location of the given planet. Returns undefined if the planet does not exist, or if we do not know the location of this planet NOT update the planet if the planet is stale, which means this function is fast.

Parameters

Name Type
planetId LocationId

Returns

undefined | WorldLocation

getMaxMoveDist

▸ getMaxMoveDist(planetId, sendingPercent, abandoning): number

Gets the maximuim distance that you can send your energy from the given planet, using the given percentage of that planet's current silver.

Parameters

Name Type
planetId LocationId
sendingPercent number
abandoning boolean

Returns

number

getMiningPattern

▸ getMiningPattern(): undefined | MiningPattern

Gets the mining pattern that the miner is currently using.

Returns

undefined | MiningPattern

getMyArtifactMap

▸ getMyArtifactMap(): Map<ArtifactId, Artifact>

Return a reference to the map of my artifacts

Returns

Map<ArtifactId, Artifact>

getMyArtifacts

▸ getMyArtifacts(): Artifact[]

gets both deposited artifacts that are on planets i own as well as artifacts i own

Returns

Artifact[]

getMyArtifactsUpdated$

▸ getMyArtifactsUpdated$(): Monomitter<Map<ArtifactId, Artifact>>

Returns

Monomitter<Map<ArtifactId, Artifact>>

getMyBalance

▸ getMyBalance(): BigNumber

Gets the balance of the account

Returns

BigNumber

getMyBalance$

▸ getMyBalance$(): Monomitter<BigNumber>

Returns the monomitter which publishes events whenever the player's balance changes.

Returns

Monomitter<BigNumber>

getMyBalanceEth

▸ getMyBalanceEth(): number

Gets the balance of the account measured in Eth (i.e. in full units of the chain).

Returns

number

getMyPlanetMap

▸ getMyPlanetMap(): Map<LocationId, Planet>

Return a reference to the map of my planets

Returns

Map<LocationId, Planet>

getMyPlanets

▸ getMyPlanets(): Planet[]

Gets a list of the planets that the player logged into this GameManager owns.

Returns

Planet[]

getMyPlanetsUpdated$

▸ getMyPlanetsUpdated$(): Monomitter<Map<LocationId, Planet>>

Returns

Monomitter<Map<LocationId, Planet>>

getMyScore

▸ getMyScore(): undefined | number

Get the score of the currently logged-in account.

Returns

undefined | number

getNextBroadcastAvailableTimestamp

▸ getNextBroadcastAvailableTimestamp(): number

Gets the timestamp (ms) of the next time that we can broadcast the coordinates of a planet.

Returns

number

getNextClaimAvailableTimestamp

▸ getNextClaimAvailableTimestamp(): number

Gets the timestamp (ms) of the next time that we can claim a planet.

Returns

number

getNextRevealCountdownInfo

▸ getNextRevealCountdownInfo(): RevealCountdownInfo

Returns info about the next time you can broadcast coordinates

Returns

RevealCountdownInfo

getNotificationsManager

▸ getNotificationsManager(): default

Returns

default

getPaused

▸ getPaused(): boolean

Returns

boolean

getPaused$

▸ getPaused$(): Monomitter<boolean>

Returns

Monomitter<boolean>

getPerlinThresholds

▸ getPerlinThresholds(): [number, number, number]

The perlin value at each coordinate determines the space type. There are four space types, which means there are four ranges on the number line that correspond to each space type. This function returns the boundary values between each of these four ranges: PERLIN_THRESHOLD_1, PERLIN_THRESHOLD_2, PERLIN_THRESHOLD_3.

Returns

[number, number, number]

getPlanetLevel

▸ getPlanetLevel(planetId): undefined | PlanetLevel

Gets the level of the given planet. Returns undefined if the planet does not exist. Does NOT update the planet if the planet is stale, which means this function is fast.

Parameters

Name Type
planetId LocationId

Returns

undefined | PlanetLevel

getPlanetMap

▸ getPlanetMap(): Map<LocationId, Planet>

Return a reference to the planet map

Returns

Map<LocationId, Planet>

getPlanetRarity

▸ getPlanetRarity(): number

Gets the rarity of planets in the universe

Returns

number

getPlanetUpdated$

▸ getPlanetUpdated$(): Monomitter<LocationId>

Returns

Monomitter<LocationId>

getPlanetWithCoords

▸ getPlanetWithCoords(coords): undefined | LocatablePlanet

Gets the planet that is located at the given coordinates. Returns undefined if not a valid location or if no planet exists at location. If the planet needs to be updated (because some time has passed since we last updated the planet), then updates that planet first.

Parameters

Name Type
coords WorldCoords

Returns

undefined | LocatablePlanet

getPlanetWithId

▸ getPlanetWithId(planetId): undefined | Planet

Gets the planet with the given hash. Returns undefined if the planet is neither in the contract nor has been discovered locally. If the planet needs to be updated (because some time has passed since we last updated the planet), then updates that planet first.

Parameters

Name Type
planetId undefined | LocationId

Returns

undefined | Planet

getPlanetsInRange

▸ getPlanetsInRange(planetId, sendingPercent, abandoning): Planet[]

Gets all the planets that you can reach with at least 1 energy from the given planet. Does not take into account wormholes.

Parameters

Name Type
planetId LocationId
sendingPercent number
abandoning boolean

Returns

Planet[]

getPlanetsInWorldRectangle

▸ getPlanetsInWorldRectangle(worldX, worldY, worldWidth, worldHeight, levels, planetLevelToRadii, updateIfStale?): LocatablePlanet[]

Gets the ids of all the planets that are both within the given bounding box (defined by its bottom left coordinate, width, and height) in the world and of a level that was passed in via the planetLevels parameter.

Parameters

Name Type Default value
worldX number undefined
worldY number undefined
worldWidth number undefined
worldHeight number undefined
levels number[] undefined
planetLevelToRadii Map<number, Radii> undefined
updateIfStale boolean true

Returns

LocatablePlanet[]

getPlanetsWithIds

▸ getPlanetsWithIds(planetId): Planet[]

Gets a list of planets in the client's memory with the given ids. If a planet with the given id doesn't exist, no entry for that planet will be returned in the result.

Parameters

Name Type
planetId LocationId[]

Returns

Planet[]

getPlayer

▸ getPlayer(address?): undefined | Player

Gets either the given player, or if no address was provided, gets the player that is logged this client.

Parameters

Name Type
address? EthAddress

Returns

undefined | Player

getPlayerScore

▸ getPlayerScore(addr): undefined | number

Parameters

Name Type
addr EthAddress

Returns

undefined | number

getPlayerSpaceJunk

▸ getPlayerSpaceJunk(addr): undefined | number

Parameters

Name Type
addr EthAddress

Returns

undefined | number

getPlayerSpaceJunkLimit

▸ getPlayerSpaceJunkLimit(addr): undefined | number

Parameters

Name Type
addr EthAddress

Returns

undefined | number

getPrivateKey

▸ getPrivateKey(): undefined | string

Gets the private key of the burner wallet used by this account.

Returns

undefined | string

getRangeBuff

▸ getRangeBuff(abandoning): number

Parameters

Name Type
abandoning boolean

Returns

number

getRevealedLocations

▸ getRevealedLocations(): Map<LocationId, RevealedLocation>

Gets a map of all location IDs whose coords have been publically revealed

Returns

Map<LocationId, RevealedLocation>

getSafeMode

▸ getSafeMode(): boolean

Returns

boolean

getSignedTwitter

▸ getSignedTwitter(twitter): Promise<string>

Signs the given twitter handle with the private key of the current user. Used to verify that the person who owns the Dark Forest account was the one that attempted to link a twitter to their account.

Parameters

Name Type
twitter string

Returns

Promise<string>

getSilverCurveAtPercent

▸ getSilverCurveAtPercent(planet, percent): undefined | number

returns timestamp (seconds) that planet will reach percent% of silcap if doesn't produce silver, returns undefined if already over percent% of silcap,

Parameters

Name Type
planet Planet
percent number

Returns

undefined | number

getSilverOfPlayer

▸ getSilverOfPlayer(player): number

Gets the total amount of silver that lives on planets that the given player owns.

Parameters

Name Type
player EthAddress

Returns

number

getSnarkHelper

▸ getSnarkHelper(): default

Returns

default

getSpaceships

▸ Private getSpaceships(): Promise<void>

Returns

Promise<void>

getSpeedBuff

▸ getSpeedBuff(abandoning): number

Right now the only buffs supported in this way are speed/range buffs from Abandoning a planet.

The abandoning argument is used when interacting with this function programmatically.

Parameters

Name Type
abandoning boolean

Returns

number

getStalePlanetWithId

▸ getStalePlanetWithId(planetId): undefined | Planet

Parameters

Name Type
planetId LocationId

Returns

undefined | Planet

getTemperature

▸ getTemperature(coords): number

Gets the temperature of a given location.

Parameters

Name Type
coords WorldCoords

Returns

number

getTimeForMove

▸ getTimeForMove(fromId, toId, abandoning?): number

Gets the amount of time, in seconds that a voyage between from the first to the second planet would take.

Parameters

Name Type Default value
fromId LocationId undefined
toId LocationId undefined
abandoning boolean false

Returns

number

getTokenMintEndTimeSeconds

▸ getTokenMintEndTimeSeconds(): number

Dark Forest tokens can only be minted up to a certain time - get this time measured in seconds from epoch.

Returns

number

getTwitter

▸ getTwitter(address): undefined | string

Gets the twitter handle of the given ethereum account which is associated with Dark Forest.

Parameters

Name Type
address undefined | EthAddress

Returns

undefined | string

getUIEventEmitter

▸ getUIEventEmitter(): default

Helpful for listening to user input events.

Returns

default

getUnconfirmedMoves

▸ getUnconfirmedMoves(): Transaction<UnconfirmedMove>[]

Gets all moves that this client has queued to be uploaded to the contract, but have not been successfully confirmed yet.

Returns

Transaction<UnconfirmedMove>[]

getUnconfirmedUpgrades

▸ getUnconfirmedUpgrades(): Transaction<UnconfirmedUpgrade>[]

Gets all upgrades that this client has queued to be uploaded to the contract, but have not been successfully confirmed yet.

Returns

Transaction<UnconfirmedUpgrade>[]

getUnconfirmedWormholeActivations

▸ getUnconfirmedWormholeActivations(): Transaction<UnconfirmedActivateArtifact>[]

Returns

Transaction<UnconfirmedActivateArtifact>[]

getUniverseTotalEnergy

▸ getUniverseTotalEnergy(): number

Gets the total amount of energy that lives on a planet that somebody owns.

Returns

number

getUpgrade

▸ getUpgrade(branch, level): Upgrade

Returns the upgrade that would be applied to a planet given a particular upgrade branch (defense, range, speed) and level of upgrade.

Parameters

Name Type
branch number
level number

Returns

Upgrade

getWorldRadius

▸ getWorldRadius(): number

Gets the radius of the playable area of the universe.

Returns

number

getWorldSilver

▸ getWorldSilver(): number

Gets the total amount of silver that lives on a planet that somebody owns.

Returns

number

getWormholeFactors

▸ getWormholeFactors(fromPlanet, toPlanet): undefined | { distanceFactor: number ; speedFactor: number }

If there's an active artifact on either of these planets which happens to be a wormhole which is active and targetting the other planet, return the wormhole boost which is greater. Values represent a multiplier.

Parameters

Name Type
fromPlanet Planet
toPlanet Planet

Returns

undefined | { distanceFactor: number ; speedFactor: number }

getWormholes

▸ getWormholes(): Iterable<Wormhole>

Returns

Iterable<Wormhole>

hardRefreshArtifact

▸ hardRefreshArtifact(artifactId): Promise<void>

Parameters

Name Type
artifactId ArtifactId

Returns

Promise<void>

hardRefreshPlanet

▸ hardRefreshPlanet(planetId): Promise<void>

Parameters

Name Type
planetId LocationId

Returns

Promise<void>

hardRefreshPlayer

▸ Private hardRefreshPlayer(address?): Promise<void>

Parameters

Name Type
address? EthAddress

Returns

Promise<void>

hasJoinedGame

▸ hasJoinedGame(): boolean

Whether or not this client has successfully found and landed on a home planet.

Returns

boolean

hasMinedChunk

▸ hasMinedChunk(chunkLocation): boolean

Whether or not the given rectangle has been mined.

Parameters

Name Type
chunkLocation Rectangle

Returns

boolean

initMiningManager

▸ Private initMiningManager(homeCoords, cores?): void

Parameters

Name Type
homeCoords WorldCoords
cores? number

Returns

void

invadePlanet

▸ invadePlanet(locationId): Promise<Transaction<UnconfirmedInvadePlanet>>

Parameters

Name Type
locationId LocationId

Returns

Promise<Transaction<UnconfirmedInvadePlanet>>

isAdmin

▸ isAdmin(): boolean

Returns

boolean

isMining

▸ isMining(): boolean

Whether or not the miner is currently exploring space.

Returns

boolean

isPlanetMineable

▸ isPlanetMineable(p): boolean

Whether or not the given planet is capable of minting an artifact.

Parameters

Name Type
p Planet

Returns

boolean

isRoundOver

▸ isRoundOver(): boolean

Returns whether or not the current round has ended.

Returns

boolean

joinGame

▸ joinGame(beforeRetry): Promise<void>

Attempts to join the game. Should not be called once you've already joined.

Parameters

Name Type
beforeRetry (e: Error) => Promise<boolean>

Returns

Promise<void>

listenForNewBlock

▸ listenForNewBlock(): void

Returns

void

loadContract

▸ loadContract<T>(contractAddress, contractABI): Promise<T>

Returns an instance of a Contract from the ethersjs library. This is the library we use to connect to the blockchain. For documentation about how Contract works, see: https://docs.ethers.io/v5/api/contract/contract/

Also, registers your contract in the system to make calls against it and to reload it when necessary (such as the RPC endpoint changing).

Type parameters

Name Type
T extends Contract<T>

Parameters

Name Type
contractAddress string
contractABI ContractInterface

Returns

Promise<T>

loadPlugins

▸ loadPlugins(): Promise<SerializedPlugin[]>

Load the serialized versions of all the plugins that this player has.

Returns

Promise<SerializedPlugin[]>

locationBigIntFromCoords

▸ locationBigIntFromCoords(coords): BigInteger

Parameters

Name Type
coords WorldCoords

Returns

BigInteger

locationFromCoords

▸ Private locationFromCoords(coords): WorldLocation

computes the WorldLocation object corresponding to a set of coordinates very slow since it actually calculates the hash; do not use in render loop

Parameters

Name Type
coords WorldCoords

Returns

WorldLocation

move

▸ move(from, to, forces, silver, artifactMoved?, abandoning?, bypassChecks?): Promise<Transaction<UnconfirmedMove>>

Submits a transaction to the blockchain to move the given amount of resources from the given planet to the given planet.

Parameters

Name Type Default value
from LocationId undefined
to LocationId undefined
forces number undefined
silver number undefined
artifactMoved? ArtifactId undefined
abandoning boolean false
bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedMove>>

onTxCancelled

▸ Private onTxCancelled(tx): void

Parameters

Name Type
tx Transaction<TxIntent>

Returns

void

onTxConfirmed

▸ Private onTxConfirmed(tx): void

Parameters

Name Type
tx Transaction<TxIntent>

Returns

void

onTxReverted

▸ Private onTxReverted(tx): void

Parameters

Name Type
tx Transaction<TxIntent>

Returns

void

onTxSubmit

▸ Private onTxSubmit(tx): void

Parameters

Name Type
tx Transaction<TxIntent>

Returns

void

prospectPlanet

▸ prospectPlanet(planetId, bypassChecks?): Promise<Transaction<UnconfirmedProspectPlanet>>

Parameters

Name Type Default value
planetId LocationId undefined
bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedProspectPlanet>>

refreshNetworkHealth

▸ Private refreshNetworkHealth(): Promise<void>

Returns

Promise<void>

refreshScoreboard

▸ Private refreshScoreboard(): Promise<void>

Returns

Promise<void>

refreshServerPlanetStates

▸ refreshServerPlanetStates(planetIds): Promise<void>

We have two locations which planet state can live: on the server, and on the blockchain. We use the blockchain for the 'physics' of the universe, and the webserver for optional 'add-on' features, which are cryptographically secure, but live off-chain.

This function loads the planet states which live on the server. Plays nicely with our notifications system and sets the appropriate loading state values on the planet.

Parameters

Name Type
planetIds LocationId[]

Returns

Promise<void>

refreshTwitters

▸ Private refreshTwitters(): Promise<void>

Returns

Promise<void>

revealLocation

▸ revealLocation(planetId): Promise<Transaction<UnconfirmedReveal>>

Reveals a planet's location on-chain.

Parameters

Name Type
planetId LocationId

Returns

Promise<Transaction<UnconfirmedReveal>>

savePlugins

▸ savePlugins(savedPlugins): Promise<void>

Overwrites all the saved plugins to equal the given array of plugins.

Parameters

Name Type
savedPlugins SerializedPlugin[]

Returns

Promise<void>

setMinerCores

▸ setMinerCores(nCores): void

Set the amount of cores to mine the universe with. More cores equals faster!

Parameters

Name Type
nCores number

Returns

void

setMiningPattern

▸ setMiningPattern(pattern): void

Sets the mining pattern of the miner. This kills the old miner and starts this one.

Parameters

Name Type
pattern MiningPattern

Returns

void

setPlanetEmoji

▸ setPlanetEmoji(locationId, emojiStr): Promise<void>

If you are the owner of this planet, you can set an 'emoji' to hover above the planet. emojiStr must be a string that contains a single emoji, otherwise this function will throw an error.

The emoji is stored off-chain in a postgres database. We verify planet ownership via a contract call from the webserver, and by verifying that the request to add (or remove) an emoji from a planet was signed by the owner.

Parameters

Name Type
locationId LocationId
emojiStr string

Returns

Promise<void>

setPlayerTwitters

▸ Private setPlayerTwitters(twitters): void

Parameters

Name Type
twitters AddressTwitterMap

Returns

void

setRadius

▸ Private setRadius(worldRadius): void

Parameters

Name Type
worldRadius number

Returns

void

setSafeMode

▸ setSafeMode(safeMode): void

Parameters

Name Type
safeMode boolean

Returns

void

setSnarkCacheSize

▸ setSnarkCacheSize(size): void

Changes the amount of move snark proofs that are cached.

Parameters

Name Type
size number

Returns

void

softRefreshPlanet

▸ Private softRefreshPlanet(planetId): Promise<void>

Parameters

Name Type
planetId LocationId

Returns

Promise<void>

spaceTypeFromPerlin

▸ spaceTypeFromPerlin(perlin): SpaceType

Each coordinate lives in a particular type of space, determined by a smooth random function called 'perlin noise.

Parameters

Name Type
perlin number

Returns

SpaceType

spaceTypePerlin

▸ spaceTypePerlin(coords, floor): number

Gets the perlin value at the given location in the world. SpaceType is based on this value.

Parameters

Name Type
coords WorldCoords
floor boolean

Returns

number

startExplore

▸ startExplore(): void

Starts the miner.

Returns

void

stopExplore

▸ stopExplore(): void

Stops the miner.

Returns

void

submitDisconnectTwitter

▸ submitDisconnectTwitter(twitter): Promise<void>

Parameters

Name Type
twitter string

Returns

Promise<void>

submitPlanetMessage

▸ Private submitPlanetMessage(locationId, type, body): Promise<void>

The planet emoji feature is built on top of a more general 'Planet Message' system, which allows players to upload pieces of data called 'Message's to planets that they own. Emojis are just one type of message. Their implementation leaves the door open to more off-chain data.

Parameters

Name Type
locationId LocationId
type PlanetMessageType
body unknown

Returns

Promise<void>

submitTransaction

▸ submitTransaction<T>(txIntent, overrides?): Promise<Transaction<T>>

Type parameters

Name Type
T extends TxIntent

Parameters

Name Type
txIntent T
overrides? TransactionRequest

Returns

Promise<Transaction<T>>

submitVerifyTwitter

▸ submitVerifyTwitter(twitter): Promise<boolean>

Once you have posted the verification tweet - complete the twitter-account-linking process by telling the Dark Forest webserver to look at that tweet.

Parameters

Name Type
twitter string

Returns

Promise<boolean>

testNotification

▸ testNotification(): void

Returns

void

timeUntilNextBroadcastAvailable

▸ timeUntilNextBroadcastAvailable(): number

Gets the amount of time (ms) until the next time the current player can broadcast a planet.

Returns

number

transferOwnership

▸ transferOwnership(planetId, newOwner, bypassChecks?): Promise<Transaction<UnconfirmedPlanetTransfer>>

Parameters

Name Type Default value
planetId LocationId undefined
newOwner EthAddress undefined
bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedPlanetTransfer>>

updateDiagnostics

▸ updateDiagnostics(updateFn): void

Updates the diagnostic info of the game using the supplied function. Ideally, each spot in the codebase that would like to record a metric is able to update its specific metric in a convenient manner.

Parameters

Name Type
updateFn (d: Diagnostics) => void

Returns

void

upgrade

▸ upgrade(planetId, branch, _bypassChecks?): Promise<Transaction<UnconfirmedUpgrade>>

Submits a transaction to the blockchain to upgrade the given planet with the given upgrade branch. You must own the planet, and have enough silver on it to complete the upgrade.

Parameters

Name Type Default value
planetId LocationId undefined
branch number undefined
_bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedUpgrade>>

uploadDiagnostics

▸ Private uploadDiagnostics(): Promise<void>

Returns

Promise<void>

verifyMessage

▸ Private verifyMessage(message): Promise<boolean>

Checks that a message signed by {@link GameManager#signMessage} was signed by the address that it claims it was signed by.

Parameters

Name Type
message SignedMessage<unknown>

Returns

Promise<boolean>

waitForPlanet

▸ waitForPlanet<T>(locationId, predicate): Promise<T>

Listen for changes to a planet take action, eg. waitForPlanet("yourAsteroidId", ({current}) => current.silverCap / current.silver > 90) .then(() => { // Send Silver to nearby planet })

Type parameters

Name
T

Parameters

Name Type Description
locationId LocationId A locationId to watch for updates
predicate (__namedParameters: Diff<Planet>) => undefined | T a function that accepts a Diff and should return a truth-y value, value will be passed to promise.resolve()

Returns

Promise<T>

a promise that will resolve with results returned from the predicate function

withdrawArtifact

▸ withdrawArtifact(locationId, artifactId, bypassChecks?): Promise<Transaction<UnconfirmedWithdrawArtifact>>

Withdraws the artifact that is locked up on the given planet.

Parameters

Name Type Default value
locationId LocationId undefined
artifactId ArtifactId undefined
bypassChecks boolean true

Returns

Promise<Transaction<UnconfirmedWithdrawArtifact>>

withdrawSilver

▸ withdrawSilver(locationId, amount, bypassChecks?): Promise<Transaction<UnconfirmedWithdrawSilver>>

Parameters

Name Type Default value
locationId LocationId undefined
amount number undefined
bypassChecks boolean false

Returns

Promise<Transaction<UnconfirmedWithdrawSilver>>

create

▸ Static create(__namedParameters): Promise<default>

Parameters

Name Type
__namedParameters Object
__namedParameters.connection EthConnection
__namedParameters.contractAddress EthAddress
__namedParameters.terminal MutableRefObject<undefined | TerminalHandle>

Returns

Promise<default>