Class Principal

Hierarchy

Principal

Index

Constructors

constructor

Properties

_isPrincipal

Methods

Constructors

Protected constructor

new Principal(_arr: Uint8Array): Principal

- Defined in index.ts:90
Parameters
- _arr: Uint8Array
Returns Principal

Properties

Readonly _isPrincipal

_isPrincipal: true = true

Methods

compareTo

compareTo(other: Principal): "lt" | "eq" | "gt"

- Defined in index.ts:139
Utility method taking a Principal to compare against. Used for determining canister ranges in certificate verification

Parameters
- other: Principal
  
  a Principal to compare
Returns "lt" | "eq" | "gt"
'lt' | 'eq' | 'gt' a string, representing less than, equal to, or greater than

gtEq

gtEq(other: Principal): boolean

- Defined in index.ts:165
Utility method checking whether a provided Principal is greater than or equal to the current one using the Principal.compareTo method

Parameters
- other: Principal
  
  a Principal to compare
Returns boolean
boolean

isAnonymous

isAnonymous(): boolean

- Defined in index.ts:92
Returns boolean

ltEq

ltEq(other: Principal): boolean

- Defined in index.ts:155
Utility method checking whether a provided Principal is less than or equal to the current one using the Principal.compareTo method

Parameters
- other: Principal
  
  a Principal to compare
Returns boolean
boolean

toHex

toHex(): string

- Defined in index.ts:100
Returns string

toJSON

toJSON(): JsonnablePrincipal

- Defined in index.ts:130
Serializes to JSON

Returns JsonnablePrincipal
a JSON object with a single key, JSON_KEY_PRINCIPAL, whose value is the principal as a string

toString

toString(): string

- Defined in index.ts:122
Returns string

toText

toText(): string

- Defined in index.ts:104
Returns string

toUint8Array

toUint8Array(): Uint8Array

- Defined in index.ts:96
Returns Uint8Array

Static anonymous

anonymous(): Principal

- Defined in index.ts:22
Returns Principal

Static from

from(other: unknown): Principal

- Defined in index.ts:39
Parameters
- other: unknown
Returns Principal

Static fromHex

fromHex(hex: string): Principal

- Defined in index.ts:55
Parameters
- hex: string
Returns Principal

Static fromText

fromText(text: string): Principal

- Defined in index.ts:59
Parameters
- text: string
Returns Principal

Static fromUint8Array

fromUint8Array(arr: Uint8Array): Principal

- Defined in index.ts:84
Parameters
- arr: Uint8Array
Returns Principal

Static managementCanister

managementCanister(): Principal

- Defined in index.ts:30
Utility method, returning the principal representing the management canister, decoded from the hex string 'aaaaa-aa'

Returns Principal
principal of the management canister

Static selfAuthenticating

selfAuthenticating(publicKey: Uint8Array): Principal

- Defined in index.ts:34
Parameters
- publicKey: Uint8Array
Returns Principal

Generated using TypeDoc