@projectsophon/serde v0.1.3

@projectsophon/serde

This package contains serializers and deserializers for converting between various representations of Dark Forest data, for example between raw data received from blockchain calls to Dark Forest contracts and the typescript types used across the client.

Installation

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

npm install --save @projectsophon/serde

yarn add @projectsophon/serde

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

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

Table of contents

Functions

• address
• hashToInt
• isNetworkEvent
• isUnconfirmedActivateArtifact
• isUnconfirmedActivateArtifactTx
• isUnconfirmedBuyHat
• isUnconfirmedBuyHatTx
• isUnconfirmedCapturePlanet
• isUnconfirmedCapturePlanetTx
• isUnconfirmedDeactivateArtifact
• isUnconfirmedDeactivateArtifactTx
• isUnconfirmedDepositArtifact
• isUnconfirmedDepositArtifactTx
• isUnconfirmedFindArtifact
• isUnconfirmedFindArtifactTx
• isUnconfirmedGetShips
• isUnconfirmedGetShipsTx
• isUnconfirmedInit
• isUnconfirmedInitTx
• isUnconfirmedInvadePlanet
• isUnconfirmedInvadePlanetTx
• isUnconfirmedMove
• isUnconfirmedMoveTx
• isUnconfirmedProspectPlanet
• isUnconfirmedProspectPlanetTx
• isUnconfirmedRelease
• isUnconfirmedReleaseTx
• isUnconfirmedReveal
• isUnconfirmedRevealTx
• isUnconfirmedTransfer
• isUnconfirmedTransferTx
• isUnconfirmedUpgrade
• isUnconfirmedUpgradeTx
• isUnconfirmedWithdrawArtifact
• isUnconfirmedWithdrawArtifactTx
• isUnconfirmedWithdrawSilver
• isUnconfirmedWithdrawSilverTx
• locationIdFromBigInt
• locationIdFromDecStr
• locationIdFromEthersBN
• locationIdFromHexStr
• locationIdToDecStr

Functions

address

▸ address(str): EthAddress

Converts a string to an EthAddress: a 0x-prefixed all lowercase hex string of 40 hex characters. An object of the EthAddress type should only ever be initialized through this constructor-like method. Throws if the provided string cannot be parsed as an Ethereum address.

Parameters

Returns

EthAddress

hashToInt

▸ hashToInt(hash): number

Parameters

Returns

number

isNetworkEvent

▸ isNetworkEvent(event): event is NetworkEvent

Returns whether or not the given event is an instance of NetworkEvent. Not super stringent but works for now.

Parameters

Returns

event is NetworkEvent

isUnconfirmedActivateArtifact

▸ isUnconfirmedActivateArtifact(txIntent): txIntent is UnconfirmedActivateArtifact

Parameters

Returns

txIntent is UnconfirmedActivateArtifact

isUnconfirmedActivateArtifactTx

▸ isUnconfirmedActivateArtifactTx(tx): tx is Transaction<UnconfirmedActivateArtifact>

Parameters

Returns

tx is Transaction<UnconfirmedActivateArtifact>

isUnconfirmedBuyHat

▸ isUnconfirmedBuyHat(txIntent): txIntent is UnconfirmedBuyHat

Parameters

Returns

txIntent is UnconfirmedBuyHat

isUnconfirmedBuyHatTx

▸ isUnconfirmedBuyHatTx(tx): tx is Transaction<UnconfirmedBuyHat>

Parameters

Returns

tx is Transaction<UnconfirmedBuyHat>

isUnconfirmedCapturePlanet

▸ isUnconfirmedCapturePlanet(txIntent): txIntent is UnconfirmedCapturePlanet

Parameters

Returns

txIntent is UnconfirmedCapturePlanet

isUnconfirmedCapturePlanetTx

▸ isUnconfirmedCapturePlanetTx(tx): tx is Transaction<UnconfirmedCapturePlanet>

Parameters

Returns

tx is Transaction<UnconfirmedCapturePlanet>

isUnconfirmedDeactivateArtifact

▸ isUnconfirmedDeactivateArtifact(txIntent): txIntent is UnconfirmedDeactivateArtifact

Parameters

Returns

txIntent is UnconfirmedDeactivateArtifact

isUnconfirmedDeactivateArtifactTx

▸ isUnconfirmedDeactivateArtifactTx(tx): tx is Transaction<UnconfirmedDeactivateArtifact>

Parameters

Returns

tx is Transaction<UnconfirmedDeactivateArtifact>

isUnconfirmedDepositArtifact

▸ isUnconfirmedDepositArtifact(txIntent): txIntent is UnconfirmedDepositArtifact

Parameters

Returns

txIntent is UnconfirmedDepositArtifact

isUnconfirmedDepositArtifactTx

▸ isUnconfirmedDepositArtifactTx(tx): tx is Transaction<UnconfirmedDepositArtifact>

Parameters

Returns

tx is Transaction<UnconfirmedDepositArtifact>

isUnconfirmedFindArtifact

▸ isUnconfirmedFindArtifact(txIntent): txIntent is UnconfirmedFindArtifact

Parameters

Returns

txIntent is UnconfirmedFindArtifact

isUnconfirmedFindArtifactTx

▸ isUnconfirmedFindArtifactTx(tx): tx is Transaction<UnconfirmedFindArtifact>

Parameters

Returns

tx is Transaction<UnconfirmedFindArtifact>

isUnconfirmedGetShips

▸ isUnconfirmedGetShips(txIntent): txIntent is UnconfirmedGetShips

Parameters

Returns

txIntent is UnconfirmedGetShips

isUnconfirmedGetShipsTx

▸ isUnconfirmedGetShipsTx(tx): tx is Transaction<UnconfirmedGetShips>

Parameters

Returns

tx is Transaction<UnconfirmedGetShips>

isUnconfirmedInit

▸ isUnconfirmedInit(txIntent): txIntent is UnconfirmedInit

Parameters

Returns

txIntent is UnconfirmedInit

isUnconfirmedInitTx

▸ isUnconfirmedInitTx(tx): tx is Transaction<UnconfirmedInit>

Parameters

Returns

tx is Transaction<UnconfirmedInit>

isUnconfirmedInvadePlanet

▸ isUnconfirmedInvadePlanet(txIntent): txIntent is UnconfirmedInvadePlanet

Parameters

Returns

txIntent is UnconfirmedInvadePlanet

isUnconfirmedInvadePlanetTx

▸ isUnconfirmedInvadePlanetTx(tx): tx is Transaction<UnconfirmedInvadePlanet>

Parameters

Returns

tx is Transaction<UnconfirmedInvadePlanet>

isUnconfirmedMove

▸ isUnconfirmedMove(txIntent): txIntent is UnconfirmedMove

Parameters

Returns

txIntent is UnconfirmedMove

isUnconfirmedMoveTx

▸ isUnconfirmedMoveTx(tx): tx is Transaction<UnconfirmedMove>

Parameters

Returns

tx is Transaction<UnconfirmedMove>

isUnconfirmedProspectPlanet

▸ isUnconfirmedProspectPlanet(txIntent): txIntent is UnconfirmedProspectPlanet

Parameters

Returns

txIntent is UnconfirmedProspectPlanet

isUnconfirmedProspectPlanetTx

▸ isUnconfirmedProspectPlanetTx(tx): tx is Transaction<UnconfirmedProspectPlanet>

Parameters

Returns

tx is Transaction<UnconfirmedProspectPlanet>

isUnconfirmedRelease

▸ isUnconfirmedRelease(txIntent): txIntent is UnconfirmedMove

Parameters

Returns

txIntent is UnconfirmedMove

isUnconfirmedReleaseTx

▸ isUnconfirmedReleaseTx(tx): tx is Transaction<UnconfirmedMove>

Parameters

Returns

tx is Transaction<UnconfirmedMove>

isUnconfirmedReveal

▸ isUnconfirmedReveal(txIntent): txIntent is UnconfirmedReveal

Parameters

Returns

txIntent is UnconfirmedReveal

isUnconfirmedRevealTx

▸ isUnconfirmedRevealTx(tx): tx is Transaction<UnconfirmedReveal>

Parameters

Returns

tx is Transaction<UnconfirmedReveal>

isUnconfirmedTransfer

▸ isUnconfirmedTransfer(txIntent): txIntent is UnconfirmedPlanetTransfer

Parameters

Returns

txIntent is UnconfirmedPlanetTransfer

isUnconfirmedTransferTx

▸ isUnconfirmedTransferTx(tx): tx is Transaction<UnconfirmedPlanetTransfer>

Parameters

Returns

tx is Transaction<UnconfirmedPlanetTransfer>

isUnconfirmedUpgrade

▸ isUnconfirmedUpgrade(txIntent): txIntent is UnconfirmedUpgrade

Parameters

Returns

txIntent is UnconfirmedUpgrade

isUnconfirmedUpgradeTx

▸ isUnconfirmedUpgradeTx(tx): tx is Transaction<UnconfirmedUpgrade>

Parameters

Returns

tx is Transaction<UnconfirmedUpgrade>

isUnconfirmedWithdrawArtifact

▸ isUnconfirmedWithdrawArtifact(txIntent): txIntent is UnconfirmedWithdrawArtifact

Parameters

Returns

txIntent is UnconfirmedWithdrawArtifact

isUnconfirmedWithdrawArtifactTx

▸ isUnconfirmedWithdrawArtifactTx(tx): tx is Transaction<UnconfirmedWithdrawArtifact>

Parameters

Returns

tx is Transaction<UnconfirmedWithdrawArtifact>

isUnconfirmedWithdrawSilver

▸ isUnconfirmedWithdrawSilver(txIntent): txIntent is UnconfirmedWithdrawSilver

Parameters

Returns

txIntent is UnconfirmedWithdrawSilver

isUnconfirmedWithdrawSilverTx

▸ isUnconfirmedWithdrawSilverTx(tx): tx is Transaction<UnconfirmedWithdrawSilver>

Parameters

Returns

tx is Transaction<UnconfirmedWithdrawSilver>

locationIdFromBigInt

▸ locationIdFromBigInt(location): LocationId

Converts a BigInteger representation of location ID into a LocationID: a non-0x-prefixed all lowercase hex string of exactly 64 hex characters (0-padded). LocationIDs should only be instantiated through locationIdFromHexStr, locationIdFromDecStr, locationIdFromBigInt, and locationIdFromEthersBN.

Parameters

Returns

LocationId

locationIdFromDecStr

▸ locationIdFromDecStr(location): LocationId

Converts a string representing a decimal number into a LocationID: a non-0x-prefixed all lowercase hex string of exactly 64 hex characters (0-padded if necessary). LocationIDs should only be instantiated through locationIdFromHexStr, locationIdFromDecStr, locationIdFromBigInt, and locationIdFromEthersBN.

Parameters

Returns

LocationId

locationIdFromEthersBN

▸ locationIdFromEthersBN(location): LocationId

Converts an ethers.js BigNumber (type aliased here as EthersBN) representation of a location ID into a LocationID: a non-0x-prefixed all lowercase hex string of exactly 64 hex characters (0-padded). LocationIDs should only be instantiated through locationIdFromHexStr, locationIdFromDecStr, locationIdFromBigInt, and locationIdFromEthersBN.

Parameters

Returns

LocationId

locationIdFromHexStr

▸ locationIdFromHexStr(location): LocationId

Converts a possibly 0x-prefixed string of hex digits to a LocationId: a non-0x-prefixed all lowercase hex string of exactly 64 hex characters (0-padded if necessary). LocationIDs should only be instantiated through locationIdFromHexStr, locationIdFromDecStr, locationIdFromBigInt, and locationIdFromEthersBN.

Parameters

Returns

LocationId

locationIdToDecStr

▸ locationIdToDecStr(locationId): string

Converts a LocationID to a decimal string with the same numerical value; can be used if you need to pass an artifact ID into a web3 call.

Parameters

Returns

string