utils | superxerox-sdk

Index

Namespaces

RLP
base64

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AccessList

AccessList: { address: string; storageKeys: string[] }[]

AccessListish

AccessListish: AccessList | [string, string[]][] | Record<string, string[]>

Bytes

Bytes: ArrayLike<number>

BytesLike

BytesLike: Bytes | string

CoerceFunc

CoerceFunc: (type: string, value: any) => any

Type declaration

- (type: string, value: any): any
- Parameters
  - type: string
  - value: any
  Returns any

ConnectionInfo

ConnectionInfo: { allowGzip?: boolean; allowInsecureAuthentication?: boolean; headers?: {}; password?: string; throttleCallback?: (attempt: number, url: string) => Promise<boolean>; throttleLimit?: number; throttleSlotInterval?: number; timeout?: number; url: string; user?: string }

Type declaration

Optional allowGzip?: boolean
Optional allowInsecureAuthentication?: boolean
Optional headers?: {}
- [key: string]: string | number
Optional password?: string
Optional throttleCallback?: (attempt: number, url: string) => Promise<boolean>
- - (attempt: number, url: string): Promise<boolean>
  - Parameters
    - attempt: number
    - url: string
    Returns Promise<boolean>
Optional throttleLimit?: number
Optional throttleSlotInterval?: number
Optional timeout?: number
url: string
Optional user?: string

Deferrable

Deferrable<T>: {[ K in keyof T]: T[K] | Promise<T[K]> }

Type parameters

EncryptOptions

EncryptOptions: { client?: string; entropy?: BytesLike; iv?: BytesLike; salt?: BytesLike; scrypt?: { N?: number; p?: number; r?: number }; uuid?: string }

Type declaration

Optional client?: string
Optional entropy?: BytesLike
Optional iv?: BytesLike
Optional salt?: BytesLike
Optional scrypt?: { N?: number; p?: number; r?: number }
- Optional N?: number
- Optional p?: number
- Optional r?: number
Optional uuid?: string

FetchJsonResponse

FetchJsonResponse: { headers: {}; statusCode: number }

Type declaration

headers: {}
- [header: string]: string
statusCode: number

PollOptions

PollOptions: { ceiling?: number; floor?: number; interval?: number; onceBlock?: OnceBlockable; oncePoll?: OncePollable; retryLimit?: number; timeout?: number }

Type declaration

Optional ceiling?: number
Optional floor?: number
Optional interval?: number
Optional onceBlock?: OnceBlockable
Optional oncePoll?: OncePollable
Optional retryLimit?: number
Optional timeout?: number

ProgressCallback

ProgressCallback: (percent: number) => void

Type declaration

- (percent: number): void
- Parameters
  - percent: number
  Returns void

UnsignedTransaction

UnsignedTransaction: { accessList?: AccessListish; chainId?: number; data?: BytesLike; gasLimit?: BigNumberish; gasPrice?: BigNumberish; maxFeePerGas?: BigNumberish; maxPriorityFeePerGas?: BigNumberish; nonce?: number; to?: string; type?: number | null; value?: BigNumberish }

Type declaration

Optional accessList?: AccessListish
Optional chainId?: number
Optional data?: BytesLike
Optional gasLimit?: BigNumberish
Optional gasPrice?: BigNumberish
Optional maxFeePerGas?: BigNumberish
Optional maxPriorityFeePerGas?: BigNumberish
Optional nonce?: number
Optional to?: string
Optional type?: number | null
Optional value?: BigNumberish

Utf8ErrorFunc

Utf8ErrorFunc: (reason: Utf8ErrorReason, offset: number, bytes: ArrayLike<number>, output: number[], badCodepoint?: number) => number

Type declaration

- (reason: Utf8ErrorReason, offset: number, bytes: ArrayLike<number>, output: number[], badCodepoint?: number): number
- Parameters
  - reason: Utf8ErrorReason
  - offset: number
  - bytes: ArrayLike<number>
  - output: number[]
  - Optional badCodepoint: number
  Returns number

Variables

Const FormatTypes

FormatTypes: {}

Type declaration

[name: string]: string

Const Utf8ErrorFuncs

Utf8ErrorFuncs: {}

Type declaration

[name: string]: Utf8ErrorFunc

Const base58

base58: BaseX

Const defaultAbiCoder

defaultAbiCoder: AbiCoder

Const defaultPath

defaultPath: "m/44'/60'/0'/0/0" = "m/44'/60'/0'/0/0"

Functions

_fetchData

_fetchData<T>(connection: string | ConnectionInfo, body?: Uint8Array, processFunc?: (value: Uint8Array, response: FetchJsonResponse) => T): Promise<T>

- Defined in node_modules/@ethersproject/web/lib/index.d.ts:36
Type parameters
- T = Uint8Array
Parameters
- connection: string | ConnectionInfo
- Optional body: Uint8Array
- Optional processFunc: (value: Uint8Array, response: FetchJsonResponse) => T
  - - (value: Uint8Array, response: FetchJsonResponse): T
    - Parameters
      - value: Uint8Array
      - response: FetchJsonResponse
      Returns T
Returns Promise<T>

_toEscapedUtf8String

_toEscapedUtf8String(bytes: BytesLike, onError?: Utf8ErrorFunc): string

- Defined in node_modules/@ethersproject/strings/lib/utf8.d.ts:23
Parameters
- bytes: BytesLike
- Optional onError: Utf8ErrorFunc
Returns string

accessListify

accessListify(value: AccessListish): AccessList

- Defined in node_modules/@ethersproject/transactions/lib/index.d.ts:46
Parameters
- value: AccessListish
Returns AccessList

arrayify

arrayify(value: BytesLike | Hexable | number, options?: DataOptions): Uint8Array

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:26
Parameters
- value: BytesLike | Hexable | number
- Optional options: DataOptions
Returns Uint8Array

checkProperties

checkProperties(object: any, properties: {}): void

- Defined in node_modules/@ethersproject/properties/lib/index.d.ts:7
Parameters
- object: any
- properties: {}
  - [name: string]: boolean
Returns void

checkResultErrors

checkResultErrors(result: Result): { error: Error; path: (string | number)[] }[]

- Defined in node_modules/@ethersproject/abi/lib/coders/abstract-coder.d.ts:6
Parameters
- result: Result
Returns { error: Error; path: (string | number)[] }[]

commify

commify(value: string | number): string

- Defined in node_modules/@ethersproject/units/lib/index.d.ts:2
Parameters
- value: string | number
Returns string

computeAddress

computeAddress(key: BytesLike | string): string

- Defined in node_modules/@ethersproject/transactions/lib/index.d.ts:44
Parameters
- key: BytesLike | string
Returns string

computeHmac

computeHmac(algorithm: SupportedAlgorithm, key: BytesLike, data: BytesLike): string

- Defined in node_modules/@ethersproject/sha2/lib/sha2.d.ts:6
Parameters
- algorithm: SupportedAlgorithm
- key: BytesLike
- data: BytesLike
Returns string

computePublicKey

computePublicKey(key: BytesLike, compressed?: boolean): string

- Defined in node_modules/@ethersproject/signing-key/lib/index.d.ts:15
Parameters
- key: BytesLike
- Optional compressed: boolean
Returns string

concat

concat(items: ReadonlyArray<BytesLike>): Uint8Array

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:27
Parameters
- items: ReadonlyArray<BytesLike>
Returns Uint8Array

deepCopy

deepCopy<T>(object: T): T

- Defined in node_modules/@ethersproject/properties/lib/index.d.ts:11
Type parameters
- T
Parameters
- object: T
Returns T

defineReadOnly

defineReadOnly<T, K>(object: T, name: K, value: T[K]): void

- Defined in node_modules/@ethersproject/properties/lib/index.d.ts:1
Type parameters
- T
- K: string | number | symbol
Parameters
- object: T
- name: K
- value: T[K]
Returns void

entropyToMnemonic

entropyToMnemonic(entropy: BytesLike, wordlist?: string | Wordlist): string

- Defined in node_modules/@ethersproject/hdnode/lib/index.d.ts:40
Parameters
- entropy: BytesLike
- Optional wordlist: string | Wordlist
Returns string

fetchJson

fetchJson(connection: string | ConnectionInfo, json?: string, processFunc?: (value: any, response: FetchJsonResponse) => any): Promise<any>

- Defined in node_modules/@ethersproject/web/lib/index.d.ts:37
Parameters
- connection: string | ConnectionInfo
- Optional json: string
- Optional processFunc: (value: any, response: FetchJsonResponse) => any
  - - (value: any, response: FetchJsonResponse): any
    - Parameters
      - value: any
      - response: FetchJsonResponse
      Returns any
Returns Promise<any>

formatBytes32String

formatBytes32String(text: string): string

- Defined in node_modules/@ethersproject/strings/lib/bytes32.d.ts:2
Parameters
- text: string
Returns string

formatEther

formatEther(wei: BigNumberish): string

- Defined in node_modules/@ethersproject/units/lib/index.d.ts:5
Parameters
- wei: BigNumberish
Returns string

formatUnits

formatUnits(value: BigNumberish, unitName?: string | BigNumberish): string

- Defined in node_modules/@ethersproject/units/lib/index.d.ts:3
Parameters
- value: BigNumberish
- Optional unitName: string | BigNumberish
Returns string

getAccountPath

getAccountPath(index: number): string

- Defined in node_modules/@ethersproject/hdnode/lib/index.d.ts:42
Parameters
- index: number
Returns string

getAddress

getAddress(address: string): string

- Defined in node_modules/@ethersproject/address/lib/index.d.ts:3
Parameters
- address: string
Returns string

getContractAddress

getContractAddress(transaction: { from: string; nonce: BigNumberish }): string

- Defined in node_modules/@ethersproject/address/lib/index.d.ts:6
Parameters
- transaction: { from: string; nonce: BigNumberish }
  - from: string
  - nonce: BigNumberish
Returns string

getCreate2Address

getCreate2Address(from: string, salt: BytesLike, initCodeHash: BytesLike): string

- Defined in node_modules/@ethersproject/address/lib/index.d.ts:10
Parameters
- from: string
- salt: BytesLike
- initCodeHash: BytesLike
Returns string

getIcapAddress

getIcapAddress(address: string): string

- Defined in node_modules/@ethersproject/address/lib/index.d.ts:5
Parameters
- address: string
Returns string

getJsonWalletAddress

getJsonWalletAddress(json: string): string

- Defined in node_modules/@ethersproject/json-wallets/lib/inspect.d.ts:3
Parameters
- json: string
Returns string

getStatic

getStatic<T>(ctor: any, key: string): T

- Defined in node_modules/@ethersproject/properties/lib/index.d.ts:2
Type parameters
- T
Parameters
- ctor: any
- key: string
Returns T

hashMessage

hashMessage(message: Bytes | string): string

- Defined in node_modules/@ethersproject/hash/lib/message.d.ts:3
Parameters
- message: Bytes | string
Returns string

hexConcat

hexConcat(items: ReadonlyArray<BytesLike>): string

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:34
Parameters
- items: ReadonlyArray<BytesLike>
Returns string

hexDataLength

hexDataLength(data: BytesLike): number

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:32
Parameters
- data: BytesLike
Returns number

hexDataSlice

hexDataSlice(data: BytesLike, offset: number, endOffset?: number): string

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:33
Parameters
- data: BytesLike
- offset: number
- Optional endOffset: number
Returns string

hexStripZeros

hexStripZeros(value: BytesLike): string

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:36
Parameters
- value: BytesLike
Returns string

hexValue

hexValue(value: BytesLike | Hexable | number | bigint): string

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:35
Parameters
- value: BytesLike | Hexable | number | bigint
Returns string

hexZeroPad

hexZeroPad(value: BytesLike, length: number): string

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:37
Parameters
- value: BytesLike
- length: number
Returns string

hexlify

hexlify(value: BytesLike | Hexable | number | bigint, options?: DataOptions): string

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:31
Parameters
- value: BytesLike | Hexable | number | bigint
- Optional options: DataOptions
Returns string

id

id(text: string): string

- Defined in node_modules/@ethersproject/hash/lib/id.d.ts:1
Parameters
- text: string
Returns string

isAddress

isAddress(address: string): boolean

- Defined in node_modules/@ethersproject/address/lib/index.d.ts:4
Parameters
- address: string
Returns boolean

isBytes

isBytes(value: any): value is Bytes

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:25
Parameters
- value: any
Returns value is Bytes

isBytesLike

isBytesLike(value: any): value is BytesLike

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:24
Parameters
- value: any
Returns value is BytesLike

isHexString

isHexString(value: any, length?: number): boolean

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:30
Parameters
- value: any
- Optional length: number
Returns boolean

isValidMnemonic

isValidMnemonic(mnemonic: string, wordlist?: Wordlist): boolean

- Defined in node_modules/@ethersproject/hdnode/lib/index.d.ts:41
Parameters
- mnemonic: string
- Optional wordlist: Wordlist
Returns boolean

isValidName

isValidName(name: string): boolean

- Defined in node_modules/@ethersproject/hash/lib/namehash.d.ts:1
Parameters
- name: string
Returns boolean

joinSignature

joinSignature(signature: SignatureLike): string

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:39
Parameters
- signature: SignatureLike
Returns string

keccak256

keccak256(data: BytesLike): string

- Defined in node_modules/@ethersproject/keccak256/lib/index.d.ts:2
Parameters
- data: BytesLike
Returns string

mnemonicToEntropy

mnemonicToEntropy(mnemonic: string, wordlist?: string | Wordlist): string

- Defined in node_modules/@ethersproject/hdnode/lib/index.d.ts:39
Parameters
- mnemonic: string
- Optional wordlist: string | Wordlist
Returns string

mnemonicToSeed

mnemonicToSeed(mnemonic: string, password?: string): string

- Defined in node_modules/@ethersproject/hdnode/lib/index.d.ts:38
Parameters
- mnemonic: string
- Optional password: string
Returns string

namehash

namehash(name: string): string

- Defined in node_modules/@ethersproject/hash/lib/namehash.d.ts:2
Parameters
- name: string
Returns string

nameprep

nameprep(value: string): string

- Defined in node_modules/@ethersproject/strings/lib/idna.d.ts:4
Parameters
- value: string
Returns string

parseBytes32String

parseBytes32String(bytes: BytesLike): string

- Defined in node_modules/@ethersproject/strings/lib/bytes32.d.ts:3
Parameters
- bytes: BytesLike
Returns string

parseEther

parseEther(ether: string): BigNumber

- Defined in node_modules/@ethersproject/units/lib/index.d.ts:6
Parameters
- ether: string
Returns BigNumber

parseTransaction

parseTransaction(rawTransaction: BytesLike): Transaction

- Defined in node_modules/@ethersproject/transactions/lib/index.d.ts:48
Parameters
- rawTransaction: BytesLike
Returns Transaction

parseUnits

parseUnits(value: string, unitName?: BigNumberish): BigNumber

- Defined in node_modules/@ethersproject/units/lib/index.d.ts:4
Parameters
- value: string
- Optional unitName: BigNumberish
Returns BigNumber

poll

poll<T>(func: () => Promise<T>, options?: PollOptions): Promise<T>

- Defined in node_modules/@ethersproject/web/lib/index.d.ts:38
Type parameters
- T
Parameters
- func: () => Promise<T>
  - - (): Promise<T>
    - Returns Promise<T>
- Optional options: PollOptions
Returns Promise<T>

randomBytes

randomBytes(length: number): Uint8Array

- Defined in node_modules/@ethersproject/random/lib/random.d.ts:1
Parameters
- length: number
Returns Uint8Array

recoverAddress

recoverAddress(digest: BytesLike, signature: SignatureLike): string

- Defined in node_modules/@ethersproject/transactions/lib/index.d.ts:45
Parameters
- digest: BytesLike
- signature: SignatureLike
Returns string

recoverPublicKey

recoverPublicKey(digest: BytesLike, signature: SignatureLike): string

- Defined in node_modules/@ethersproject/signing-key/lib/index.d.ts:14
Parameters
- digest: BytesLike
- signature: SignatureLike
Returns string

resolveProperties

resolveProperties<T>(object: Readonly<Deferrable<T>>): Promise<T>

- Defined in node_modules/@ethersproject/properties/lib/index.d.ts:6
Type parameters
- T
Parameters
- object: Readonly<Deferrable<T>>
Returns Promise<T>

ripemd160

ripemd160(data: BytesLike): string

- Defined in node_modules/@ethersproject/sha2/lib/sha2.d.ts:3
Parameters
- data: BytesLike
Returns string

serializeTransaction

serializeTransaction(transaction: UnsignedTransaction, signature?: SignatureLike): string

- Defined in node_modules/@ethersproject/transactions/lib/index.d.ts:47
Parameters
- transaction: UnsignedTransaction
- Optional signature: SignatureLike
Returns string

sha256

sha256(data: BytesLike): string

- Defined in node_modules/@ethersproject/sha2/lib/sha2.d.ts:4
Parameters
- data: BytesLike
Returns string

sha512

sha512(data: BytesLike): string

- Defined in node_modules/@ethersproject/sha2/lib/sha2.d.ts:5
Parameters
- data: BytesLike
Returns string

shallowCopy

shallowCopy<T>(object: T): T

- Defined in node_modules/@ethersproject/properties/lib/index.d.ts:10
Type parameters
- T
Parameters
- object: T
Returns T

shuffled

shuffled(array: any[]): any[]

- Defined in node_modules/@ethersproject/random/lib/shuffle.d.ts:1
Parameters
- array: any[]
Returns any[]

solidityKeccak256

solidityKeccak256(types: ReadonlyArray<string>, values: ReadonlyArray<any>): string

- Defined in node_modules/@ethersproject/solidity/lib/index.d.ts:2
Parameters
- types: ReadonlyArray<string>
- values: ReadonlyArray<any>
Returns string

solidityPack

solidityPack(types: ReadonlyArray<string>, values: ReadonlyArray<any>): string

- Defined in node_modules/@ethersproject/solidity/lib/index.d.ts:1
Parameters
- types: ReadonlyArray<string>
- values: ReadonlyArray<any>
Returns string

soliditySha256

soliditySha256(types: ReadonlyArray<string>, values: ReadonlyArray<any>): string

- Defined in node_modules/@ethersproject/solidity/lib/index.d.ts:3
Parameters
- types: ReadonlyArray<string>
- values: ReadonlyArray<any>
Returns string

splitSignature

splitSignature(signature: SignatureLike): Signature

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:38
Parameters
- signature: SignatureLike
Returns Signature

stripZeros

stripZeros(value: BytesLike): Uint8Array

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:28
Parameters
- value: BytesLike
Returns Uint8Array

toUtf8Bytes

toUtf8Bytes(str: string, form?: UnicodeNormalizationForm): Uint8Array

- Defined in node_modules/@ethersproject/strings/lib/utf8.d.ts:22
Parameters
- str: string
- Optional form: UnicodeNormalizationForm
Returns Uint8Array

toUtf8CodePoints

toUtf8CodePoints(str: string, form?: UnicodeNormalizationForm): number[]

- Defined in node_modules/@ethersproject/strings/lib/utf8.d.ts:26
Parameters
- str: string
- Optional form: UnicodeNormalizationForm
Returns number[]

toUtf8String

toUtf8String(bytes: BytesLike, onError?: Utf8ErrorFunc): string

- Defined in node_modules/@ethersproject/strings/lib/utf8.d.ts:25
Parameters
- bytes: BytesLike
- Optional onError: Utf8ErrorFunc
Returns string

verifyMessage

verifyMessage(message: Bytes | string, signature: SignatureLike): string

- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:31
Parameters
- message: Bytes | string
- signature: SignatureLike
Returns string

verifyTypedData

verifyTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, any>, signature: SignatureLike): string

- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:32
Parameters
- domain: TypedDataDomain
- types: Record<string, TypedDataField[]>
- value: Record<string, any>
- signature: SignatureLike
Returns string

zeroPad

zeroPad(value: BytesLike, length: number): Uint8Array

- Defined in node_modules/@ethersproject/bytes/lib/index.d.ts:29
Parameters
- value: BytesLike
- length: number
Returns Uint8Array

Generated using TypeDoc

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AccessList

AccessListish

Bytes

BytesLike

CoerceFunc

Type declaration

Parameters

type: string

value: any

Returns any

ConnectionInfo

Type declaration

Optional allowGzip?: boolean

Optional allowInsecureAuthentication?: boolean

Optional headers?: {}

[key: string]: string | number

Optional password?: string

Optional throttleCallback?: (attempt: number, url: string) => Promise<boolean>

Parameters

attempt: number

url: string

Returns Promise<boolean>

Optional throttleLimit?: number

Optional throttleSlotInterval?: number

Optional timeout?: number

url: string

Optional user?: string

Deferrable

Type parameters

T

EncryptOptions

Type declaration

Optional client?: string

Optional entropy?: BytesLike

Optional iv?: BytesLike

Optional salt?: BytesLike

Optional scrypt?: { N?: number; p?: number; r?: number }

Optional N?: number

Optional p?: number

Optional r?: number

Optional uuid?: string

FetchJsonResponse

Type declaration

headers: {}

[header: string]: string

statusCode: number

PollOptions

Type declaration

Optional ceiling?: number

Optional floor?: number

Optional interval?: number

Optional onceBlock?: OnceBlockable

Optional oncePoll?: OncePollable

Optional retryLimit?: number

Optional timeout?: number

ProgressCallback

Type declaration

Parameters

percent: number

Returns void

UnsignedTransaction

Type declaration

Optional accessList?: AccessListish

Optional chainId?: number

Optional data?: BytesLike

Optional gasLimit?: BigNumberish

Optional gasPrice?: BigNumberish

Optional maxFeePerGas?: BigNumberish

Optional maxPriorityFeePerGas?: BigNumberish

Optional nonce?: number

Optional to?: string