utils

package
v0.14.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 15, 2025 License: MIT Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var RANDOM_FELT = new(felt.Felt).SetUint64(3735928559) //nolint:mnd

Just a random felt variable to use when needed. The value is "0xdeadbeef"

Functions

func All 

func All[T any](slice []T, f func(T) bool) bool

All returns true if all elements match the given predicate

func BigIntArrToFeltArr 

func BigIntArrToFeltArr(bigArr []*big.Int) []*felt.Felt

BigIntArrToFeltArr converts an array of big.Int objects to an array of Felt objects.

Parameters:

  • bigArr: the array of big.Int objects to convert

Returns:

  • []*felt.Felt: the array of Felt objects

func BigIntToFelt 

func BigIntToFelt(bigNum *big.Int) *felt.Felt

BigIntToFelt converts a big integer to a felt.Felt.

Parameters:

  • bigNum: the big integer to convert

Returns:

  • *felt.Felt: the converted value

func BigToHex 

func BigToHex(in *big.Int) string

BigToHex converts a big integer to its hexadecimal representation.

Parameters:

  • in: the big integer to be converted

Returns:

  • string: the hexadecimal representation

func ByteArrFeltToString 

func ByteArrFeltToString(arr []*felt.Felt) (string, error)

ByteArrFeltToString converts array of Felts to string. The input array of felts will be of the format

[number of felts with 31 characters in length, 31 byte felts..., pending word with max size of 30 bytes, pending words bytes size]

For further explanation, refer the article

Parameters:

  • []*felt.Felt: the array of felt.Felt objects

Returns:

  • s: string/bytearray

  • error: an error, if any

func BytesToBig 

func BytesToBig(bytesVal []byte) *big.Int

BytesToBig converts a byte slice to a big.Int.

Parameters:

  • bytesVal: the byte slice to be converted

Returns:

  • *big.Int: the converted value

func ComputeFact 

func ComputeFact(programHash *big.Int, programOutputs []*big.Int) *big.Int

ComputeFact computes the factorial of a given number.

Parameters:

  • programHash: a pointer to a big.Int representing the program hash
  • programOutputs: a slice of pointers to big.Int representing the program outputs

Returns:

  • *big.Int: a pointer to a big.Int representing the computed factorial

func ETHToWei 

func ETHToWei(eth float64) *felt.Felt

ETHToWei converts an ETH amount to Wei Returns the Wei value as a *felt.Felt

func FeltArrToBigIntArr 

func FeltArrToBigIntArr(f []*felt.Felt) []*big.Int

FeltArrToBigIntArr converts an array of Felt objects to an array of big.Int objects.

Parameters:

  • f: the array of Felt objects to convert

Returns:

  • []*big.Int: the array of big.Int objects

func FeltArrToStringArr 

func FeltArrToStringArr(f []*felt.Felt) []string

FeltArrToStringArr converts an array of Felt objects to an array of string objects.

Parameters:

  • f: the array of Felt objects to convert

Returns:

  • []string: the array of string objects

func FeltToBigInt 

func FeltToBigInt(f *felt.Felt) *big.Int

FeltToBigInt converts a Felt value to a *big.Int.

Parameters:

  • f: the Felt value to convert

Returns:

  • *big.Int: the converted value

func FillHexWithZeroes added in v0.12.0 

func FillHexWithZeroes(hex string) string

FillHexWithZeroes normalises a hex string to have a '0x' prefix and pads it with leading zeros to a total length of 66 characters (including the '0x' prefix).

func Filter 

func Filter[T any](slice []T, f func(T) bool) []T

Filter filters a slice of type T using the given predicate, returning a new slice with the elements that match the predicate

func Flatten 

func Flatten[T any](sl ...[]T) []T

Flatten flattens a slice of slices into a single slice

func FmtKecBytes 

func FmtKecBytes(in *big.Int, rolen int) (buf []byte)

FmtKecBytes formats the given big.Int as a byte slice (Keccak hash) with a specified length.

The function appends the bytes of the big.Int to a buffer and returns it. If the length of the buffer is less than the specified length, the function pads the buffer with zeros.

Parameters:

  • in: the big.Int to be formatted
  • rolen: the length of the buffer

Returns: buf: the formatted buffer

func GetAndUnmarshalJSONFromMap 

func GetAndUnmarshalJSONFromMap[T any](aMap map[string]json.RawMessage, key string) (result T, err error)

GetAndUnmarshalJSONFromMap retrieves and unmarshals a JSON value from a map into the specified type T.

Parameters:

  • aMap: A map containing JSON raw messages
  • key: The key to look up in the map

Returns:

  • T: The unmarshaled value of type T
  • error: An error if the key is not found or unmarshaling fails

func GetSelectorFromName 

func GetSelectorFromName(funcName string) *big.Int

GetSelectorFromName generates a selector from a given function name.

Parameters:

  • funcName: the name of the function

Returns:

  • *big.Int: the selector

func GetSelectorFromNameFelt 

func GetSelectorFromNameFelt(funcName string) *felt.Felt

GetSelectorFromNameFelt returns a *felt.Felt based on the given function name.

Parameters:

  • funcName: the name of the function

Returns:

  • *felt.Felt: the *felt.Felt

func HexArrToBNArr 

func HexArrToBNArr(hexArr []string) []*big.Int

HexArrToBNArr converts a hexadecimal string array to a *big.Int array. Trim "0x" prefix(if exists)

Parameters:

  • hexArr: the hexadecimal string array to be converted

Returns:

  • *big.Int: the converted array

func HexArrToFelt 

func HexArrToFelt(hexArr []string) ([]*felt.Felt, error)

HexArrToFelt converts an array of hexadecimal strings to an array of felt objects.

The function iterates over each element in the hexArr array and calls the HexToFelt function to convert each hexadecimal value to a felt object. If any error occurs during the conversion, the function will return nil and the corresponding error. Otherwise, it appends the converted felt object to the feltArr array. Finally, the function returns the feltArr array containing all the converted felt objects.

Parameters:

  • hexArr: an array of strings representing hexadecimal values

Returns:

  • []*felt.Felt: an array of *felt.Felt objects, or nil if there was
  • error: an error if any

func HexToBN 

func HexToBN(hexString string) *big.Int

HexToBN converts a hexadecimal string to a big.Int. trim "0x" prefix(if exists)

Parameters:

  • hexString: the hexadecimal string to be converted

Returns:

  • *big.Int: the converted value

func HexToBytes 

func HexToBytes(hexString string) ([]byte, error)

HexToBytes converts a hexadecimal string to a byte slice. trim "0x" prefix(if exists)

Parameters:

  • hexString: the hexadecimal string to be converted

Returns:

  • []byte: the converted value
  • error: an error if any

func HexToFelt 

func HexToFelt(hexVal string) (*felt.Felt, error)

HexToFelt converts a hexadecimal string to a *felt.Felt object.

Parameters:

  • hexVal: the input hexadecimal string to be converted.

Returns:

  • *felt.Felt: a *felt.Felt object
  • error: if conversion fails

func HexToShortStr 

func HexToShortStr(hexStr string) string

HexToShortStr converts a hexadecimal string to a short string (Starknet) representation.

Parameters:

  • hexStr: the hexadecimal string to convert to a short string

Returns:

  • string: a short string

func HexToU256Felt 

func HexToU256Felt(hexStr string) ([]*felt.Felt, error)

HexToU256Felt converts a hexadecimal string to a Cairo u256 representation. The Cairo u256 is represented as two felt.Felt values:

  • The first felt.Felt contains the 128 least significant bits (low part)
  • The second felt.Felt contains the 128 most significant bits (high part)

Parameters:

  • hexStr: the hexadecimal string to convert to a Cairo u256

Returns:

  • []*felt.Felt: a slice containing two felt.Felt values [low, high]
  • error: if conversion fails

func Keccak256 

func Keccak256(data ...[]byte) []byte

Keccak256 returns the Keccak-256 hash of the input data. (ref: https://github.com/ethereum/go-ethereum/blob/master/crypto/crypto.go)

Parameters:

  • data: a variadic parameter of type []byte representing the input data

Returns:

  • []byte: a 32-byte hash output

func Map 

func Map[T1, T2 any](slice []T1, f func(T1) T2) []T2

Map maps a slice of type T1 to a slice of type T2 using the given function

func MaskBits 

func MaskBits(mask, wordSize int, slice []byte) (ret []byte)

MaskBits masks (excess) bits in a slice of bytes based on the given mask and wordSize.

Parameters:

  • mask: an integer representing the number of bits to mask
  • wordSize: an integer representing the size of each word in bits
  • slice: a slice of bytes to mask

Returns:

  • ret: a slice of bytes with the masked bits

func RemoveFieldFromJSON 

func RemoveFieldFromJSON(jsonData *[]byte, field string) error

RemoveFieldFromJSON removes a field from a JSON bytes slice.

Parameters:

  • jsonData: pointer to the JSON data
  • field: string field to remove, it must be a direct child of the JSON object

Returns:

  • error: error if any

func SNValToBN 

func SNValToBN(str string) *big.Int

SNValToBN converts a given string to a *big.Int by checking if the string contains "0x" prefix. used in string conversions when interfacing with the APIs

Parameters:

  • str: a string to be converted to *big.Int

Returns:

  • *big.Int: a pointer to a big.Int representing the converted value

func SplitFactStr 

func SplitFactStr(fact string) (fact_low, fact_high string, err error)

SplitFactStr splits a given fact, with maximum 256 bits size, into two parts (felts): fact_low and fact_high.

The function takes a fact string as input and converts it to a big number using the HexToBN function. It then converts the big number to bytes using the Bytes method. If the length of the bytes is less than 32, it pads the bytes with zeros using the bytes.Repeat method. The padded bytes are then appended to the original bytes. The function then extracts the low part of the bytes by taking the last 16 bytes and converts it to a big number using the BytesToBig function. It also extracts the high part of the bytes by taking the first 16 bytes and converts it to a big number using the BytesToBig function. Finally, it converts the low and high big numbers to hexadecimal strings using the BigToHex function and returns them.

Parameters:

  • fact: The fact string to be split

Return types:

  • fact_low: The low part of the fact string in hexadecimal format
  • fact_high: The high part of the fact string in hexadecimal format
  • err: An error if any

func StrToBig 

func StrToBig(str string) *big.Int

StrToBig generates a *big.Int from a string representation.

Parameters:

  • str: The string to convert to a *big.Int

Returns:

  • *big.Int: a pointer to a big.Int representing the converted value

func StrToHex 

func StrToHex(str string) string

StrToBig generates a hexadecimal from a string/number representation.

Parameters:

  • str: The string to convert to a hexadecimal

Returns:

  • hex: a string representing the converted value

func StringToByteArrFelt 

func StringToByteArrFelt(s string) ([]*felt.Felt, error)

StringToByteArrFelt converts string to array of Felt objects. The returned array of felts will be of the format

[number of felts with 31 characters in length, 31 byte felts..., pending word with max size of 30 bytes, pending words bytes size]

For further explanation, refer the article

Parameters:

  • s: string/bytearray to convert

Returns:

  • []*felt.Felt: the array of felt.Felt objects

  • error: an error, if any

func TestHexArrToFelt 

func TestHexArrToFelt(t testing.TB, hexArr []string) []*felt.Felt

TestHexArrToFelt generates a slice of *felt.Felt from a slice of strings representing hexadecimal values.

Parameters:

  • t: A testing.TB interface used for test logging and error reporting
  • hexArr: A slice of strings representing hexadecimal values

Returns:

  • []*felt.Felt: a slice of *felt.Felt

func TestHexToFelt 

func TestHexToFelt(t testing.TB, hex string) *felt.Felt

TestHexToFelt generates a felt.Felt from a hexadecimal string.

Parameters:

  • t: the testing.TB object for test logging and reporting
  • hex: the hexadecimal string to convert to a felt.Felt

Returns:

  • *felt.Felt: the generated felt.Felt object

func TestUnmarshalJSONFileToType 

func TestUnmarshalJSONFileToType[T any](t testing.TB, filePath, subfield string) *T

TestUnmarshalJSONFileToType reads a JSON file at the given path and unmarshals it into the specified type T. If any error occurs during file reading or unmarshalling, it fails the test.

Parameters:

  • t: testing.TB interface for test logging and error reporting
  • filePath: string path to the JSON file
  • subfield: string subfield to unmarshal from the JSON file

Returns:

  • T: the unmarshalled data of type T

func U256FeltToHex 

func U256FeltToHex(u256 []*felt.Felt) (string, error)

U256FeltToHex converts a Cairo u256 representation (two felt.Felt values) back to a hexadecimal string. The Cairo u256 is represented as two felt.Felt values:

  • The first felt.Felt contains the 128 least significant bits (low part)
  • The second felt.Felt contains the 128 most significant bits (high part)

Parameters:

  • u256: a slice containing two felt.Felt values [low, high]

Returns:

  • string: the hexadecimal representation of the combined value
  • error: if conversion fails

func UTF8StrToBig 

func UTF8StrToBig(str string) *big.Int

UTF8StrToBig converts a UTF-8 string to a big integer.

Parameters:

  • str: The UTF-8 string to convert to a big integer

Returns:

  • *big.Int: a pointer to a big.Int representing the converted value

func Uint64ToFelt 

func Uint64ToFelt(num uint64) *felt.Felt

Uint64ToFelt generates a new *felt.Felt from a given uint64 number.

Parameters:

  • num: the uint64 number to convert to a *felt.Felt

Returns:

  • *felt.Felt: a *felt.Felt

func UnmarshalJSONFileToType 

func UnmarshalJSONFileToType[T any](filePath, subfield string) (*T, error)

UnmarshalJSONFileToType reads a JSON file at the given path and unmarshals it into the specified type T. If any error occurs during file reading or unmarshalling, it returns an error.

Parameters:

  • filePath: string path to the JSON file
  • subfield: string subfield to unmarshal from the JSON file

Returns:

  • *T: pointer to the unmarshalled data of type T
  • error: error if file reading or unmarshalling fails

func UnwrapJSON 

func UnwrapJSON(data map[string]any, tag string) (map[string]any, error)

func WeiToETH 

func WeiToETH(wei *felt.Felt) float64

WeiToETH converts a Wei amount to ETH Returns the ETH value as a float64

Types

type KeccakState 

type KeccakState interface {
	hash.Hash
	Read([]byte) (int, error)
}

KeccakState wraps sha3.state. In addition to the usual hash methods, it also supports Read to get a variable amount of data from the hash state. Read is faster than Sum because it doesn't copy the internal state, but also modifies the internal state.

func NewKeccakState 

func NewKeccakState() KeccakState

NewKeccakState returns a new instance of KeccakState. (ref: https://github.com/ethereum/go-ethereum/blob/master/crypto/crypto.go)

Parameters: 

none

Returns:

  • KeccakState: a new instance of KeccakState

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.