xelishash

README

Go XELIS Hash

A pure-Go XELIS Proof of Work hash CPU implementation. It's about half as fast than the reference Rust implementation.

Documentation

Index

• Constants
• func XelisHash(input []byte, scratch_pad *ScratchPad) [32]byte
• func XelisHashV2(input []byte, scratch_pad *ScratchPadV2) [32]byte
• type Hash
• type ScratchPad
• type ScratchPadV2
• type ThreadPool
  • func NewThreadPool(threads int) *ThreadPool
  • func (t *ThreadPool) Hash(algo string, input []byte) [32]byte
  • func (t *ThreadPool) XelisHash(input []byte) [32]byte
  • func (t *ThreadPool) XelisHashV2(input []byte) [32]byte

Constants

const BUFFER_SIZE = 42

const BUFFER_SIZE_V2 = MEMORY_SIZE_V2 / 2

Buffer size for stage 3 (inner loop iterations)

const BYTES_ARRAY_INPUT = KECCAK_WORDS * 8

const CHUNK_SIZE_V2 = 32

Stage 1 config

const HASH_SIZE = 32

const ITERS = 1

const KECCAK_WORDS = 25

Untweakable parameters

const KEY = "xelishash-pow-v2"

Stage 3 AES key

const MEMORY_SIZE = 32768

const MEMORY_SIZE_V2 = 429 * 128

These are tweakable parameters Memory size is the size of the scratch pad in u64s In bytes, this is equal to ~ 440KB

const NONCE_SIZE_V2 = 12

const OUTPUT_SIZE_V2 = MEMORY_SIZE_V2 * 8

const SCRATCHPAD_ITERS = 5000

const SCRATCHPAD_ITERS_V2 = 3

ScratchPadV2 iterations in stage 3

const SLOT_LENGTH = 256

const STAGE_1_MAX = MEMORY_SIZE / KECCAK_WORDS

Functions

func XelisHash

func XelisHash(input []byte, scratch_pad *ScratchPad) [32]byte

func XelisHashV2

func XelisHashV2(input []byte, scratch_pad *ScratchPadV2) [32]byte

This function is used to hash the input using the generated scratch pad NOTE: The ScratchPadV2 is completely overwritten in stage 1 and can be reused without any issues

Types

type Hash

type Hash [HASH_SIZE]byte

type ScratchPad

type ScratchPad [MEMORY_SIZE]uint64

type ScratchPadV2

type ScratchPadV2 [MEMORY_SIZE_V2]uint64

ScratchPadV2 used to store intermediate values It has a fixed size of `MEMORY_SIZE_V2` u64s It can be easily reused for multiple hashing operations safely

type ThreadPool

type ThreadPool struct {
	// contains filtered or unexported fields
}

func NewThreadPool

func NewThreadPool(threads int) *ThreadPool

func (*ThreadPool) Hash

func (t *ThreadPool) Hash(algo string, input []byte) [32]byte

Hash accepts algorithm name as string (example: xel/0, xel/1)

func (*ThreadPool) XelisHash

func (t *ThreadPool) XelisHash(input []byte) [32]byte

func (*ThreadPool) XelisHashV2

func (t *ThreadPool) XelisHashV2(input []byte) [32]byte