​

primitives/Authorization

​

Classes

​

InvalidAddressError

​

Throws

​

Extends

• InvalidFormatError

​

Constructors

Constructor

new InvalidAddressError(address, options?): InvalidAddressError

Parameters

address

options?

cause?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

InvalidChainIdError

​

Throws

​

Extends

• InvalidFormatError

​

Constructors

Constructor

new InvalidChainIdError(chainId, options?): InvalidChainIdError

Parameters

chainId

options?

cause?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

InvalidSignatureComponentError

​

Throws

​

Extends

• InvalidSignatureError

​

Constructors

Constructor

new InvalidSignatureComponentError(component, value, options?): InvalidSignatureComponentError

Parameters

component

value

options?

cause?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

name

name: string

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

InvalidSignatureRangeError

​

Throws

​

Extends

• InvalidRangeError

​

Constructors

Constructor

new InvalidSignatureRangeError(value, max, options?): InvalidSignatureRangeError

Parameters

value

max

options?

cause?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

InvalidYParityError

​

Throws

​

Extends

• InvalidRangeError

​

Constructors

Constructor

new InvalidYParityError(yParity, options?): InvalidYParityError

Parameters

yParity

options?

cause?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

expected

expected: string

Inherited from

name

name: string

Inherited from

value

value: unknown

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

MalleableSignatureError

​

Throws

​

Extends

• InvalidSignatureError

​

Constructors

Constructor

new MalleableSignatureError(s, max, options?): MalleableSignatureError

Parameters

s

max

options?

cause?

Returns

Overrides

​

Properties

cause?

optional cause: Error

Inherited from

code

code: string

Example

'INVALID_FORMAT', 'INVALID_LENGTH'

Inherited from

context?

optional context: Record<string, unknown>

Example

{ value: '0x123', expected: '20 bytes' }

Inherited from

docsPath?

optional docsPath: string

Example

'/primitives/address/from-hex#error-handling'

Inherited from

name

name: string

Inherited from

​

Methods

getErrorChain()

getErrorChain(): string

Returns

Inherited from

toJSON()

toJSON(): Record<string, unknown>

Returns

Inherited from

​

Interfaces

​

DelegationDesignation

​

Properties

authority

authority: AddressType

delegatedAddress

delegatedAddress: AddressType

​

Unsigned

​

Properties

address

address: AddressType

chainId

chainId: bigint

nonce

nonce: bigint

​

Type Aliases

​

AuthorizationType

AuthorizationType = object

​

Properties

address

address: AddressType

chainId

chainId: bigint

nonce

nonce: bigint

r

r: Uint8Array

s

s: Uint8Array

yParity

yParity: number

​

BrandedAuthorization

BrandedAuthorization = AuthorizationType

​

Deprecated

​

Variables

​

Authorization

const Authorization: object

​

Type Declaration

calculateGasCost()

calculateGasCost: (authList, emptyAccounts) => bigint

Parameters

authList

emptyAccounts

Returns

equals()

equals: (a, b) => boolean

Parameters

a

b

Returns

equalsAuth()

equalsAuth: (auth1, auth2) => boolean

Parameters

auth1

auth2

Returns

format()

format: (auth) => string

Parameters

auth

Returns

getGasCost()

getGasCost: (auth, isEmpty) => bigint

Parameters

auth

isEmpty

Returns

hash

hash: HashFn

Hash()

Hash: (deps) => HashFn

Parameters

deps

keccak256

rlpEncode

Returns

isItem()

isItem: (value) => boolean

Parameters

value

Returns

isUnsigned()

isUnsigned: (value) => boolean

Parameters

value

Returns

MAGIC_BYTE

MAGIC_BYTE: number

PER_AUTH_BASE_COST

PER_AUTH_BASE_COST: bigint

PER_EMPTY_ACCOUNT_COST

PER_EMPTY_ACCOUNT_COST: bigint

process()

process: (auth) => object

Parameters

auth

Returns

authority

authority: AddressType

delegatedAddress

delegatedAddress: AddressType

processAll()

processAll: (authList) => object[]

Parameters

authList

Returns

SECP256K1_HALF_N

SECP256K1_HALF_N: bigint

SECP256K1_N

SECP256K1_N: bigint

sign

sign: SignFn

Sign()

Sign: (deps) => SignFn

Parameters

deps

addressFromPublicKey

keccak256

recoverPublicKey

rlpEncode

sign

Returns

validate()

validate: (auth) => void

Parameters

auth

Returns

verify

verify: VerifyFn

Verify()

Verify: (deps) => VerifyFn

Parameters

deps

addressFromPublicKey

keccak256

recoverPublicKey

rlpEncode

Returns

​

calculateGasCost()

const calculateGasCost: (authList, emptyAccounts) => bigint = calculateGasCostImpl

​

Parameters

authList

emptyAccounts

​

Returns

​

equals()

const equals: (a, b) => boolean = equalsImpl

​

Parameters

a

b

​

Returns

​

equalsAuth()

const equalsAuth: (auth1, auth2) => boolean = equalsAuthImpl

​

Parameters

auth1

auth2

​

Returns

​

format()

const format: (auth) => string = formatImpl

​

Parameters

auth

​

Returns

​

getGasCost()

const getGasCost: (auth, isEmpty) => bigint = getGasCostImpl

​

Parameters

auth

isEmpty

​

Returns

​

hash

const hash: HashFn

​

Hash()

const Hash: (deps) => HashFn

​

Parameters

deps

keccak256

rlpEncode

​

Returns

​

isItem()

const isItem: (value) => boolean = isItemImpl

​

Parameters

value

​

Returns

​

isUnsigned()

const isUnsigned: (value) => boolean = isUnsignedImpl

​

Parameters

value

​

Returns

​

MAGIC_BYTE

const MAGIC_BYTE: 5 = 0x05

​

PER_AUTH_BASE_COST

const PER_AUTH_BASE_COST: 12500n = 12500n

​

PER_EMPTY_ACCOUNT_COST

const PER_EMPTY_ACCOUNT_COST: 25000n = 25000n

​

process()

const process: (auth) => object = processImpl

​

Parameters

auth

​

Returns

authority

authority: AddressType

delegatedAddress

delegatedAddress: AddressType

​

processAll()

const processAll: (authList) => object[] = processAllImpl

​

Parameters

authList

​

Returns

​

SECP256K1_HALF_N

const SECP256K1_HALF_N: bigint

​

SECP256K1_N

const SECP256K1_N: 115792089237316195423570985008687907852837564279074904382605163141518161494337n = 0xfffffffffffffffffffffffffffffffebaaedce6af48a03bbfd25e8cd0364141n

​

sign

const sign: SignFn

​

Sign()

const Sign: (deps) => SignFn

​

Parameters

deps

addressFromPublicKey

keccak256

recoverPublicKey

rlpEncode

sign

​

Returns

​

validate()

const validate: (auth) => void = validateImpl

​

Parameters

auth

​

Returns

​

verify

const verify: VerifyFn

​

Verify()

const Verify: (deps) => VerifyFn

​

Parameters

deps

addressFromPublicKey

keccak256

recoverPublicKey

rlpEncode

​

Returns

​

Functions

​

authorityWasm()

authorityWasm(auth): AddressType

​

Parameters

auth

​

Returns

​

gasCostWasm()

gasCostWasm(authCount, emptyAccounts): bigint

​

Parameters

authCount

emptyAccounts

​

Returns

​

signingHashWasm()

signingHashWasm(chainId, address, nonce): HashType

​

Parameters

chainId

address

nonce

​

Returns

​

validateWasm()

validateWasm(auth): void

​

Parameters

auth

​

Returns

​

Throws