https://github.com/psyprotocol/poseidon2
TypeScript Implementation of the Poseidon2 Hash Function (3kb 🎉)
https://github.com/psyprotocol/poseidon2
Last synced: 9 months ago
JSON representation
TypeScript Implementation of the Poseidon2 Hash Function (3kb 🎉)
- Host: GitHub
- URL: https://github.com/psyprotocol/poseidon2
- Owner: PsyProtocol
- License: mit
- Created: 2023-06-10T11:43:30.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-04T15:27:50.000Z (over 2 years ago)
- Last Synced: 2025-05-20T21:04:29.613Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 131 KB
- Stars: 9
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
poseidon2
A zero dependency implementation of the Poseidon2 hash function.
The permutation function exposed by the Poseidon2 class is one-to-one compatible with HorizenLabs/poseidon2. 3kb gzipped 🎉
# Install
```bash
npm install poseidon2
```
#### Note For TypeScript Users:
If you see the error "Cannot find module 'poseidon2/goldilocks-12' or its corresponding type declarations.ts(2307)", update your tsconfig.json to set "moduleResolution": "NodeNext".
## Usage For Goldilocks Field, T = 12
### Permute
```javascript
import { permute } from "poseidon2/goldilocks-12";
const result = permute([
1337n,
123456n,
100n,
15n,
1n,
2n,
3n,
4n,
22n,
23n,
24n,
25n,
]);
```
### Two to One (Hash two 4-element-wide values)
```javascript
import { twoToOne } from "poseidon2/goldilocks-12";
const result = twoToOne([1337n, 123456n, 100n, 15n], [1n, 2n, 3n, 4n]);
```
### Sponge Hash with Pad (Hash n elements with padding)
```javascript
import { hashPad } from "poseidon2/goldilocks-12";
const result = hashPad([1n, 2n, 3n, 1337n, 9999n, 123n]);
```
## How to use with other prime fields/t values
See [Working with other prime fields and t values](./CUSTOM_FIELD_T.md).
## Credits
Original implementation of poseidon2 by https://github.com/HorizenLabs
# License
MIT License
Copyright (c) 2023 Zero Knowledge Labs Limited
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[contributors-shield]: https://img.shields.io/github/contributors/OpenAssetStandards/poseidon2.svg?style=for-the-badge
[contributors-url]: https://github.com/OpenAssetStandards/poseidon2/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/OpenAssetStandards/poseidon2.svg?style=for-the-badge
[forks-url]: https://github.com/OpenAssetStandards/poseidon2/network/members
[stars-shield]: https://img.shields.io/github/stars/OpenAssetStandards/poseidon2.svg?style=for-the-badge
[stars-url]: https://github.com/OpenAssetStandards/poseidon2/stargazers
[issues-shield]: https://img.shields.io/github/issues/OpenAssetStandards/poseidon2.svg?style=for-the-badge
[issues-url]: https://github.com/OpenAssetStandards/poseidon2/issues