Principal

Defined in: packages/core/src/principal/principal.ts:16

Constructors

Constructor

protected new Principal(_arr): Principal

Defined in: packages/core/src/principal/principal.ts:93

Parameters

_arr

Uint8Array

Returns

Principal

Properties

_isPrincipal

readonly _isPrincipal: true = true

Defined in: packages/core/src/principal/principal.ts:91

Methods

compareTo()

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

Defined in: packages/core/src/principal/principal.ts:141

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): boolean

Defined in: packages/core/src/principal/principal.ts:167

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: packages/core/src/principal/principal.ts:95

Returns

boolean

---

ltEq()

ltEq(other): boolean

Defined in: packages/core/src/principal/principal.ts:157

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: packages/core/src/principal/principal.ts:103

Returns

string

---

toJSON()

toJSON(): JsonnablePrincipal

Defined in: packages/core/src/principal/principal.ts:132

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: packages/core/src/principal/principal.ts:124

Returns

string

---

toText()

toText(): string

Defined in: packages/core/src/principal/principal.ts:107

Returns

string

---

toUint8Array()

toUint8Array(): Uint8Array

Defined in: packages/core/src/principal/principal.ts:99

Returns

Uint8Array

---

anonymous()

static anonymous(): Principal

Defined in: packages/core/src/principal/principal.ts:17

Returns

Principal

---

from()

static from(other): Principal

Defined in: packages/core/src/principal/principal.ts:34

Parameters

other

unknown

Returns

Principal

---

fromHex()

static fromHex(hex): Principal

Defined in: packages/core/src/principal/principal.ts:46

Parameters

hex

string

Returns

Principal

---

fromText()

static fromText(text): Principal

Defined in: packages/core/src/principal/principal.ts:50

Parameters

text

string

Returns

Principal

---

fromUint8Array()

static fromUint8Array(arr): Principal

Defined in: packages/core/src/principal/principal.ts:75

Parameters

arr

Uint8Array

Returns

Principal

---

isPrincipal()

static isPrincipal(other): other is Principal

Defined in: packages/core/src/principal/principal.ts:79

Parameters

other

unknown

Returns

other is Principal

---

managementCanister()

static managementCanister(): Principal

Defined in: packages/core/src/principal/principal.ts:25

Utility method, returning the principal representing the management canister, decoded from the hex string 'aaaaa-aa'

Returns

Principal

principal of the management canister

---

selfAuthenticating()

static selfAuthenticating(publicKey): Principal

Defined in: packages/core/src/principal/principal.ts:29

Parameters

publicKey

Uint8Array

Returns

Principal