@darkforest_eth/hashing NPM

@darkforest_eth/hashing

This package contains MiMC hashing utilities for use with Dark Forest. The MiMC algorithm is used for both finding planet hashes and calculating the perlin in-game. Among other things, these values are often needed for generating Snarks.

Installation

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

npm install --save @darkforest_eth/hashing

yarn add @darkforest_eth/hashing

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

import * as hashing from 'http://cdn.skypack.dev/@darkforest_eth/hashing';

Interfaces

IntegerVector

Variables

Functions

Variables

Fraction

• Fraction: IFraction

MAX_PERLIN_VALUE

• Const MAX_PERLIN_VALUE: 32

Functions

getRandomGradientAt

▸ getRandomGradientAt(point, scale, randFn): Vector

Parameters

Name	Type
`point`	`Vector`
`scale`	`IFraction`
`randFn`	`HashFn`

Returns

Vector

mimcHash

▸ mimcHash(key): (...inputs: number[]) => BigInteger

The primary function used to build any MiMC hashing algorithm for Dark Forest.

Parameters

Name	Type	Description
`key`	`number`	The key for the MiMC algorithm. Will usually be PLANETHASH_KEY, SPACETYPE_KEY, or BIOMEBASE_KEY.

Returns

fn

▸ (...inputs): BigInteger

Parameters

Name	Type
`...inputs`	`number`[]

Returns

BigInteger

mimcSponge

▸ mimcSponge(inputs, nOutputs, rounds, key): BigInteger[]

Parameters

Name	Type
`inputs`	`BigInteger`[]
`nOutputs`	`number`
`rounds`	`number`
`key`	`number`

Returns

BigInteger[]

modPBigInt

▸ modPBigInt(x): BigInteger

Modulo a number with the LOCATION_ID_UB constant. If the result is < 0, the LOCATION_ID_UB will then be added.

Parameters

Name	Type	Description
`x`	`number`	The number to modulo against LOCATION_ID_UB

Returns

BigInteger

modPBigIntNative

▸ modPBigIntNative(x): BigInteger

Modulo a BigInt with the LOCATION_ID_UB constant. If the result is < 0, the LOCATION_ID_UB will then be added.

Parameters

Name	Type	Description
`x`	`BigInteger`	The number to modulo against LOCATION_ID_UB

Returns

BigInteger

perlin

▸ perlin(coords, options): number

Calculates the perlin for a location, given the x,y pair and the PerlinConfig for the game.

Parameters

Name	Type	Description
`coords`	`IntegerVector`	An object of the x,y coordinates for which perlin is being calculated.
`options`	`PerlinConfig`	An object containing the configuration for the perlin algorithm.

Returns

number

rand

▸ rand(key): (...args: number[]) => number

Parameters

Name	Type
`key`	`number`

Returns

fn

▸ (...args): number

Parameters

Name	Type
`...args`	`number`[]

Returns

number

seededRandom

▸ seededRandom(seed): number

Generate a random number based on some seed. Useful for procedural generation.

Parameters

Name	Type	Description
`seed`	`number`	The seed of the random number.

Returns

number

@darkforest_eth/types big-integer

@everything-registry/sub-chunk-218 @seismic-systems/ns-fow-game @darkforest_eth/procedural @darkforest_eth/renderer @darkforest_eth/whitelist @infinitebrahmanuniverse/nolb-_dar @seismic-sys/ns-fow-game @zalastax/nolb-_dar crystal-cave-contracts

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

6.7.0-staging-round-5.1

3 years ago

6.7.0-staging-round-5.0

3 years ago

6.7.0-staging-round-5-mark-2.0

3 years ago

6.7.0-arena-fake-test-2.0

3 years ago

6.7.0-arena-deploy-test.0

3 years ago

6.7.0-arena-space-junk-abandon.0

3 years ago

6.6.7

3 years ago

6.6.9

3 years ago

6.6.8

3 years ago

6.7.0-staging-round-5-mark-3.0

3 years ago

6.7.0-arena-space-junk-test-7.0

3 years ago

6.7.0-arena-space-junk-test-3.0

3 years ago

6.7.0-arena-fake-test.0

3 years ago

6.7.0

3 years ago

6.7.2

3 years ago

6.7.1

3 years ago

6.7.0-arena-round-5-1.0

3 years ago

6.7.3

3 years ago

6.7.0-staging-round-5-mark-4.0

3 years ago

6.7.0-arena-space-junk-test-6.0

3 years ago

6.7.0-arena-space-junk-test-2.0

3 years ago

6.7.0-arena-round-5-2.0

3 years ago

6.6.10

3 years ago

6.7.0-arena-andys-game.0

3 years ago

6.7.0-arena-andys-game.1

3 years ago

6.7.0-arena-fake-test-3.1

3 years ago

6.7.0-arena-fake-test-3.0

3 years ago

6.7.0-arena-round-5-test-1.0

3 years ago

6.7.0-arena-space-junk-test-5.0

3 years ago

6.7.0-arena-andys-first-day.0

3 years ago

6.7.0-arena-kooshaba-cant-read-code-good.0

3 years ago

6.7.0-arena-kooshaba-cant-read-code-good.1

3 years ago

6.7.0-arena-space-junk-8.0

3 years ago

6.7.0-arena-space-junk-4.0

3 years ago

6.7.0-staging-nov-23.0

3 years ago

6.7.0-staging-nov-11.0

3 years ago

6.7.0-staging-test-round-nov-10.0

3 years ago

6.7.0-staging-nov-16.0

3 years ago

6.7.0-staging-nov-11-2.0

3 years ago

6.7.0-staging-dec-3.0

3 years ago

6.7.0-staging-nov-23-2.0

3 years ago

6.6.0-staging-round-4.5.0

3 years ago

6.6.2-staging-round-4.5.0

3 years ago

6.6.1-staging-round-4.5.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

6.6.0-staging-round-4.4

3 years ago

6.6.0-staging-round-4.5

3 years ago

6.6.0-staging-round-4.6

3 years ago

6.6.0-staging-round-4.0

3 years ago

6.6.0-staging-round-4.1

3 years ago

6.6.0-staging-round-4.2

3 years ago

6.6.0-staging-round-4.3

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

6.3.0-staging-aug-11.4

3 years ago

6.3.0-staging-aug-11.3

3 years ago

6.3.0-staging-aug-11.2

3 years ago

6.3.0-staging-aug-11.1

3 years ago

6.3.0-staging-aug-11.0

3 years ago

6.3.0-staging-aug-12.0

3 years ago

6.3.0-staging-round-3.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

6.2.0-arena-jul-30-2021.1

3 years ago

6.2.0-arena-jul-30-2021.0

3 years ago

6.2.0-arena-jul-30-2021.3

3 years ago

6.2.0-arena-jul-30-2021.2

3 years ago

6.2.0-staging-jul-28.0

3 years ago

6.2.0-staging-jul-27-2021.0

3 years ago

6.2.0-staging-jul-27-2021-2.0

3 years ago

6.2.0-staging-r3-internal.0

3 years ago

6.2.0-staging-no-publish.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

6.2.0-arena-r3-test-4.0

3 years ago

6.2.10

3 years ago

6.2.0-arena-r3-test-1.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

6.2.0-staging-jun22.4

4 years ago

6.2.0-staging-jun22.5

4 years ago

6.2.0

4 years ago

6.2.0-staging-jun22.0

4 years ago

6.2.0-staging-jun22.1

4 years ago

6.2.0-staging-jun22.2

4 years ago

6.2.0-staging-jun22.3

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

0.6.0-staging-second-staging-2.15

4 years ago

6.0.0-arena-5-21-test.0

4 years ago

0.6.0-staging-second-staging-2.14

4 years ago

6.0.1

4 years ago

6.0.0

4 years ago

0.6.0-staging-second-staging-2.13

4 years ago

0.6.0-staging-second-staging-2.12

4 years ago

0.6.0-staging-second-staging-2.11

4 years ago

0.6.0-staging-second-staging-2.10

4 years ago

0.6.0-staging-second-staging-2.9

4 years ago

0.6.0-staging-second-staging-2.8

4 years ago

0.6.0-staging-second-staging-2.7

4 years ago

0.6.0-staging-second-staging-2.6

4 years ago

0.6.0-staging-second-staging-2.5

4 years ago

0.6.0-staging-second-staging-2.4

4 years ago

0.6.0-staging-second-staging-2.3

4 years ago

0.6.0-staging-second-staging-2.2

4 years ago

0.6.0-staging-second-staging-2.1

4 years ago

0.6.0-staging-second-staging-2.0

4 years ago

0.6.0-staging-second-staging-0.6.0.0

4 years ago

0.6.0-arena-phated6.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

@darkforest_eth/hashing v6.7.29