Class Enclave

Describes the connection a client has to an Enclave running Erdstall.

Hierarchy

Enclave

Implements

EnclaveWriter

Constructors

constructor

new Enclave(provider: EnclaveProvider): Enclave
Parameters
- provider: EnclaveProvider
Returns Enclave
- Defined in src/enclave/connection.ts:129

Properties

`Private` calls

calls: Map<string, [Function, Function]>

`Private` globallySubscribed

globallySubscribed: boolean

`Private` handlers

`Private` id

id: number

`Private` individuallySubscribed

individuallySubscribed: Set<string>

`Private` internalHandlers

`Private` internalOneShotHandlers

`Private` oneShotHandlers

`Private` phaseShiftSubscribed

phaseShiftSubscribed: boolean

`Private` provider

provider: EnclaveProvider

Methods

attest

attest(): Promise<AttestationResult>
Queries the enclave's remote attestation.

Returns
A promise to the enclave's remote attestation.

Throws
An error if the attestation was not generated by the enclave yet.

Returns Promise<AttestationResult>
Implementation of EnclaveWriter.attest
- Defined in src/enclave/connection.ts:185

burn

burn(tx: Burn): Promise<TxAccepted>
Sends the given burn transaction to the enclave.

Returns
A promise containing the transaction accepted message for this burn.
Parameters
- tx: Burn
  
  The burn transaction to send.
Returns Promise<TxAccepted>
Implementation of EnclaveWriter.burn
- Defined in src/enclave/connection.ts:200

`Private` callEvent

callEvent(ev: "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof", payload: any): void
Parameters
- ev: "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"
- payload: any
Returns void
- Defined in src/enclave/connection.ts:342

connect

connect(): void
Returns void
Implementation of EnclaveWriter.connect
- Defined in src/enclave/connection.ts:150

disconnect

disconnect(): void
Returns void
Implementation of EnclaveWriter.disconnect
- Defined in src/enclave/connection.ts:158

exit

exit(exitRequest: ExitRequest): Promise<BalanceProof>
Sends the given exit request to the enclave.

Returns
A promise containing the balance proof with its exit flag set.
Parameters
- exitRequest: ExitRequest
Returns Promise<BalanceProof>
Implementation of EnclaveWriter.exit
- Defined in src/enclave/connection.ts:208

getAccount

getAccount(acc: Address): Promise<responses.Account>
Retrieves the account state for the given address within Erdstall.

Returns
A promise containing the state of the account in Erdstall.
Parameters
- acc: Address
  
  The address of interest.
Returns Promise<responses.Account>
Implementation of EnclaveWriter.getAccount
- Defined in src/enclave/connection.ts:217

`Private` handleUnknownMessage

handleUnknownMessage(data: string): void
Parameters
- data: string
Returns void
- Defined in src/enclave/connection.ts:359

isEnclaveWriter

isEnclaveWriter(): void
Returns void
Implementation of EnclaveWriter.isEnclaveWriter
- Defined in src/enclave/connection.ts:148

mint

mint(tx: Mint): Promise<TxAccepted>
Sends the given mint transaction to the enclave.

Returns
A promise containing the transaction accepted message for this mint.
Parameters
- tx: Mint
  
  The mint transaction to send.
Returns Promise<TxAccepted>
Implementation of EnclaveWriter.mint
- Defined in src/enclave/connection.ts:196

`Private` nextID

nextID(): number
Returns number
- Defined in src/enclave/connection.ts:282

off

off<T>(eventType: T, cb: ErdstallEventHandler<T>): void
Unregisters a callback for the given event.
Type Parameters
- T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"
  
  Type of event the callback is parameterized on.
Parameters
- eventType: T
  
  The event of interest.
- cb: ErdstallEventHandler<T>
  
  The callback depending on the type of ev.
Returns void
Implementation of EnclaveWriter.off
- Defined in src/enclave/connection.ts:249

off_internal

off_internal<T>(eventType: T, cb: ErdstallEventHandler<T>): void
Type Parameters
- T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"
Parameters
- eventType: T
- cb: ErdstallEventHandler<T>
Returns void
- Defined in src/enclave/connection.ts:270

on

on<T>(eventType: T, cb: ErdstallEventHandler<T>): void
Registers a callback for the given event, s.t. it fires everytime until manually unregistered with off(ev, cb).

Remarks
The registered callback should always be manually unregistered.
Type Parameters
- T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"
  
  Type of event the callback is parameterized on.
Parameters
- eventType: T
  
  The event of interest.
- cb: ErdstallEventHandler<T>
  
  The callback depending on the type of ev.
Returns void
Implementation of EnclaveWriter.on
- Defined in src/enclave/connection.ts:235

`Private` onClose

onClose(_: Event): void
Parameters
- _: Event
Returns void
- Defined in src/enclave/connection.ts:395

`Private` onError

onError(ev: Event): void
Parameters
- ev: Event
Returns void
- Defined in src/enclave/connection.ts:363

`Private` onMessage

onMessage(ev: MessageEvent<any>): any
Parameters
- ev: MessageEvent<any>
Returns any
- Defined in src/enclave/connection.ts:286

`Private` onOpen

onOpen(_: Event): void
Parameters
- _: Event
Returns void
- Defined in src/enclave/connection.ts:376

on_internal

on_internal<T>(eventType: T, cb: ErdstallEventHandler<T>): void
Type Parameters
- T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"
Parameters
- eventType: T
- cb: ErdstallEventHandler<T>
Returns void
- Defined in src/enclave/connection.ts:256

onboard

onboard(who: Address): Promise<void>
Enters Erdstall with the given address.
Parameters
- who: Address
Returns Promise<void>
Implementation of EnclaveWriter.onboard
- Defined in src/enclave/connection.ts:162

once

once<T>(eventType: T, cb: ErdstallEventHandler<T>): void
Registers a callback for the given event, s.t. it fires only ONCE. Once registered, a callback cannot be unregistered again.
Type Parameters
- T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"
  
  Type of event the callback is parameterized on.
Parameters
- eventType: T
  
  The event of interest.
- cb: ErdstallEventHandler<T>
  
  The callback depending on the type of ev.
Returns void
Implementation of EnclaveWriter.once
- Defined in src/enclave/connection.ts:242

once_internal

once_internal<T>(eventType: T, cb: ErdstallEventHandler<T>): void
Type Parameters
- T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"
Parameters
- eventType: T
- cb: ErdstallEventHandler<T>
Returns void
- Defined in src/enclave/connection.ts:263

removeAllListeners

removeAllListeners(): void
Removes all registered callbacks for all events.

Returns void
Implementation of EnclaveWriter.removeAllListeners
- Defined in src/enclave/connection.ts:277

`Private` sendCall

sendCall(data: ErdstallObject): Promise<ErdstallObject>
Parameters
- data: ErdstallObject
Returns Promise<ErdstallObject>
- Defined in src/enclave/connection.ts:221

subscribe(who?: Address): Promise<void>
Subscribes the entity to receive TxReceipts and BalanceProofs concerning either all or the specified address.

Handlers for incoming messages can be set using on and once.

Returns
An empty promise which can be awaited.
Parameters
- Optional who: Address
  
  When omitted subscribes to ALL available BalanceProofs and TxReceipts.
Returns Promise<void>
Implementation of EnclaveWriter.subscribe
- Defined in src/enclave/connection.ts:168

trade

trade(tx: Trade): Promise<TxAccepted>
Sends the given trade transaction to the enclave.

Returns
A promise containing the transaction accepted message for this trade.
Parameters
- tx: Trade
  
  The trade transaction to send.
Returns Promise<TxAccepted>
Implementation of EnclaveWriter.trade
- Defined in src/enclave/connection.ts:204

transfer

transfer(tx: Transfer): Promise<TxAccepted>
Sends the given transfer transaction to the enclave.

Returns
A promise containing the transaction accepted message for this transfer.
Parameters
- tx: Transfer
  
  The transfer transaction to send.
Returns Promise<TxAccepted>
Implementation of EnclaveWriter.transfer
- Defined in src/enclave/connection.ts:192

`Static` dial

dial(operator: URL): Enclave
Parameters
- operator: URL
Returns Enclave
- Defined in src/enclave/connection.ts:125

Class Enclave

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

provider: EnclaveProvider

Returns Enclave

Properties

Private calls

Private globallySubscribed

Private handlers

Private id

Private individuallySubscribed

Private internalHandlers

Private internalOneShotHandlers

Private oneShotHandlers

Private phaseShiftSubscribed

Private provider

Methods

attest

Returns

Throws

Returns Promise<AttestationResult>

burn

Returns

Parameters

tx: Burn

Returns Promise<TxAccepted>

Private callEvent

Parameters

ev: "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"

payload: any

Returns void

connect

Returns void

disconnect

Returns void

exit

Returns

Parameters

exitRequest: ExitRequest

Returns Promise<BalanceProof>

getAccount

Returns

Parameters

acc: Address

Returns Promise<responses.Account>

Private handleUnknownMessage

Parameters

data: string

Returns void

isEnclaveWriter

Returns void

mint

Returns

Parameters

tx: Mint

Returns Promise<TxAccepted>

Private nextID

Returns number

off

Type Parameters

T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"

Parameters

eventType: T

cb: ErdstallEventHandler<T>

Returns void

off_internal

Type Parameters

T extends "error" | "open" | "close" | "config" | "receipt" | "phaseshift" | "proof" | "exitproof"

Parameters

eventType: T

cb: ErdstallEventHandler<T>

Returns void

on

`Private` calls

`Private` globallySubscribed

`Private` handlers

`Private` id

`Private` individuallySubscribed

`Private` internalHandlers

`Private` internalOneShotHandlers

`Private` oneShotHandlers

`Private` phaseShiftSubscribed

`Private` provider

`Private` callEvent

`Private` handleUnknownMessage

`Private` nextID

`Private` onClose

`Private` onError

`Private` onMessage

`Private` onOpen

`Private` sendCall

`Optional` who: Address

`Static` dial