common.go

// Copyright 2021 ChainSafe Systems (ON)
// SPDX-License-Identifier: LGPL-3.0-only

package common

import (
	"encoding/binary"
	"encoding/hex"
	"errors"
	"fmt"
	"io"
	"strconv"
	"strings"
)

// ErrNoPrefix is returned when trying to convert a hex-encoded string with no 0x prefix
var ErrNoPrefix = errors.New("could not byteify non 0x prefixed string")

// StringToInts turns a string consisting of ints separated by commas into an int array
func StringToInts(in string) (res []int, err error) {
	intstrs := strings.Split(in, ",")
	for _, intstr := range intstrs {
		i, err := strconv.Atoi(intstr)
		if err != nil {
			return res, err
		}
		res = append(res, i)
	}
	return res, nil
}

// StringArrayToBytes turns an array of strings into an array of byte arrays
func StringArrayToBytes(in []string) [][]byte {
	b := make([][]byte, len(in))
	for i := range in {
		b[i] = []byte(in[i])
	}
	return b
}

// BytesToStringArray turns an array of byte arrays into an array strings
func BytesToStringArray(in [][]byte) []string {
	strs := make([]string, len(in))
	for i := range in {
		strs[i] = string(in[i])
	}
	return strs
}

// HexToBytes turns a 0x prefixed hex string into a byte slice
func HexToBytes(in string) (b []byte, err error) {
	if !strings.HasPrefix(in, "0x") {
		return nil, fmt.Errorf("%w: %s", ErrNoPrefix, in)
	}

	b, err = hex.DecodeString(in[2:])
	if err != nil {
		return nil, fmt.Errorf("%w: %s", err, in)
	}

	return b, nil
}

// MustHexToBytes turns a 0x prefixed hex string into a byte slice
// it panic if it cannot decode the string
func MustHexToBytes(in string) []byte {
	if len(in) < 2 {
		panic("invalid string")
	}

	if strings.Compare(in[:2], "0x") != 0 {
		panic(ErrNoPrefix)
	}

	// Ensure we have an even length, otherwise hex.DecodeString will fail and return zero hash
	if len(in)%2 != 0 {
		panic("cannot decode an odd length string")
	}

	in = in[2:]
	out, err := hex.DecodeString(in)
	if err != nil {
		panic(err)
	}

	return out
}

// BytesToHex turns a byte slice into a 0x prefixed hex string
func BytesToHex(in []byte) string {
	s := hex.EncodeToString(in)
	return "0x" + s
}

// Concat concatenates two byte arrays
// used instead of append to prevent modifying the original byte array
func Concat(s1 []byte, s2 ...byte) []byte {
	r := make([]byte, len(s1)+len(s2))
	copy(r, s1)
	copy(r[len(s1):], s2)
	return r
}

// Uint16ToBytes converts a uint16 into a 2-byte slice
func Uint16ToBytes(in uint16) (out []byte) {
	out = make([]byte, 2)
	out[0] = byte(in & 0x00ff)
	out[1] = byte(in >> 8 & 0x00ff)
	return out
}

// UintToBytes converts a uint into a Big Endian byte slice
// using a compact number of bytes. This is to imitate
// the big.Int().Bytes() behaviour.
func UintToBytes(n uint) (b []byte) {
	b = make([]byte, 0)
	for n > 0 {
		b = append([]byte{byte(n & 0xFF)}, b...)
		n >>= 8
	}
	return b
}

// UintToHex converts a uint into the hex string representation
// of a Big Endian byte slice using 4 bytes for values that fit
// in a uint32 and in 8 bytes otherwise.
func UintToHex(n uint) (hexString string) {
	b := UintToBytes(n)
	return BytesToHex(b)
}

// BytesToUint converts a bytes slice in Big Endian compact
// format to a uint. This is to imitate the
// big.NewInt(0).SetBytes(b) behaviour.
func BytesToUint(b []byte) (n uint) {
	for i := range b {
		byteValue := uint(b[i])
		shift := (len(b) - i - 1) * 8
		n += byteValue << shift
	}
	return n
}

// HexToUint converts a hex string of bytes in Big Endian compact
// format to a uint. See BytesToUint for more details.
func HexToUint(hexString string) (n uint, err error) {
	b, err := HexToBytes(hexString)
	if err != nil {
		return 0, err
	}
	return BytesToUint(b), nil
}

// AppendZeroes appends zeroes to the input byte array up until it has length l
func AppendZeroes(in []byte, l int) []byte {
	for {
		if len(in) >= l {
			return in
		}
		in = append(in, 0)
	}
}

// SwapByteNibbles swaps the two nibbles of a byte
func SwapByteNibbles(b byte) byte {
	b1 := (uint(b) & 240) >> 4
	b2 := (uint(b) & 15) << 4

	return byte(b1 | b2)
}

// SwapNibbles swaps the nibbles for each byte in the byte array
func SwapNibbles(k []byte) []byte {
	result := make([]byte, len(k))
	for i, b := range k {
		result[i] = SwapByteNibbles(b)
	}
	return result
}

// ReadByte reads a byte from the reader and returns it
func ReadByte(r io.Reader) (byte, error) {
	buf := make([]byte, 1)
	_, err := r.Read(buf)
	if err != nil {
		return 0, err
	}
	return buf[0], nil
}

// Read4Bytes reads 4 bytes from the reader and returns it
func Read4Bytes(r io.Reader) ([]byte, error) {
	buf := make([]byte, 4)
	_, err := r.Read(buf)
	if err != nil {
		return nil, err
	}
	return buf, nil
}

// ReadUint32 reads a 4-byte uint32 from the reader and returns it
func ReadUint32(r io.Reader) (uint32, error) {
	buf := make([]byte, 4)
	_, err := r.Read(buf)
	if err != nil {
		return 0, err
	}
	return binary.LittleEndian.Uint32(buf), nil
}

// ReadUint64 reads an 8-byte uint32 from the reader and returns it
func ReadUint64(r io.Reader) (uint64, error) {
	buf := make([]byte, 8)
	_, err := r.Read(buf)
	if err != nil {
		return 0, err
	}
	return binary.LittleEndian.Uint64(buf), nil
}

// Read8Bytes reads 8 bytes from the reader and returns it
func Read8Bytes(r io.Reader) ([8]byte, error) {
	buf := make([]byte, 8)
	_, err := r.Read(buf)
	if err != nil {
		return [8]byte{}, err
	}
	h := [8]byte{}
	copy(h[:], buf)
	return h, nil
}

// Read32Bytes reads 32 bytes from the reader and returns it
func Read32Bytes(r io.Reader) ([32]byte, error) {
	buf := make([]byte, 32)
	_, err := r.Read(buf)
	if err != nil {
		return [32]byte{}, err
	}
	h := [32]byte{}
	copy(h[:], buf)
	return h, nil
}

// Read64Bytes reads 64 bytes from the reader and returns it
func Read64Bytes(r io.Reader) ([64]byte, error) {
	buf := make([]byte, 64)
	_, err := r.Read(buf)
	if err != nil {
		return [64]byte{}, err
	}
	h := [64]byte{}
	copy(h[:], buf)
	return h, nil
}

// ReadBytes reads the given number bytes from the reader and returns it
func ReadBytes(r io.Reader, n int) ([]byte, error) {
	buf := make([]byte, n)
	_, err := r.Read(buf)
	if err != nil {
		return nil, err
	}
	return buf, nil
}