npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dfdao/hashing

v6.7.31

Published

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.

Downloads

3

Readme

@dfdao/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 @dfdao/hashing
yarn add @dfdao/hashing

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

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

Table of contents

Interfaces

Variables

Functions

Interfaces

IntegerVector

IntegerVector: Interface IntegerVector

A object containing a pair of x,y coordinates.

Variables

Fraction

Fraction: IFraction


MAX_PERLIN_VALUE

MAX_PERLIN_VALUE: 32 = 32

Functions

getRandomGradientAt

Const getRandomGradientAt(point, scale, randFn): Vector

Parameters

| Name | Type | | :------- | :-------- | | point | Vector | | scale | IFraction | | randFn | HashFn |

Returns

Vector


mimcHash

mimcHash(key): Function

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

Function

▸ (...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

Const rand(key): Function

Parameters

| Name | Type | | :---- | :----- | | key | number |

Returns

Function

▸ (...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