Class for interacting with Enclave Accounts in the SwitchboardAttestationService.sol contract.

// Instantiate an EnclaveAccount
const enclaveAccount = new EnclaveAccount(switchboardProgram, '0xYourEnclaveAccountAddress');

// Load the data
const enclave = await enclaveAccount.loadData();
const name = enclave.name;

Hierarchy

• EnclaveAccount
  • LoadedEnclaveAccount

Index

Constructors

• constructor

Properties

• address
• data
• switchboard

Accessors

• account
• authority
• balance
• cid
• isOnQueue
• lastHeartbeat
• mrEnclave
• queueId
• signer
• validUntil
• verificationStatus
• verificationTimestamp

Methods

• forceOverrideVerify
• heartbeat
• isEnclaveValid
• loadData
• pollVerification
• toJSON
• toObj
• updateEnclave
• verifyEnclave
• create
• initAndAwaitVerification
• load
• signerToAddress

Constructors

constructor

• new LoadedEnclaveAccount(switchboard: ISwitchboardProgram, address: string, data: any): LoadedEnclaveAccount

• Overrides EnclaveAccount.constructor

  Parameters

  • switchboard: ISwitchboardProgram

  • address: string

  • data: any

  Returns LoadedEnclaveAccount

Properties

readonlyaddress

address: string

Inherited from EnclaveAccount.address

address of the EnclaveAccount

publicdata

data: any

readonlyswitchboard

switchboard: ISwitchboardProgram

Inherited from EnclaveAccount.switchboard

the instance of Switchboard program

Accessors

publicaccount

• get account(): EnclaveAccount

• Returns EnclaveAccount

publicauthority

• get authority(): string

• Returns string

publicbalance

• get balance(): BigNumber

• Returns BigNumber

publiccid

• get cid(): string

• Returns string

publicisOnQueue

• get isOnQueue(): boolean

• Returns boolean

publiclastHeartbeat

• get lastHeartbeat(): number

• Returns number

publicmrEnclave

• get mrEnclave(): string

• Returns string

publicqueueId

• get queueId(): string

• Returns string

publicsigner

• get signer(): string

• Returns string

publicvalidUntil

• get validUntil(): number

• Returns number

publicverificationStatus

• get verificationStatus(): PENDING | FAILURE | SUCCESS | OVERRIDE

• Returns PENDING | FAILURE | SUCCESS | OVERRIDE

publicverificationTimestamp

• get verificationTimestamp(): number

• Returns number

Methods

publicforceOverrideVerify

• forceOverrideVerify(options?: any): Promise<ContractTransaction>

• Inherited from EnclaveAccount.forceOverrideVerify

  Method to force an override verification

  ---

  Parameters

  • optionaloptions: any

    Transaction options

  Returns Promise<ContractTransaction>

  Promise that resolves to ContractTransaction

  const contractTransaction = await enclaveAccount.forceOverrideVerify(options);

publicheartbeat

• heartbeat(options?: any): Promise<ContractTransaction>

• Inherited from EnclaveAccount.heartbeat

  Parameters

  • optionaloptions: any

  Returns Promise<ContractTransaction>

publicisEnclaveValid

• isEnclaveValid(): Promise<boolean>

• Inherited from EnclaveAccount.isEnclaveValid

  Method to check if the enclave is valid

  ---

  Returns Promise<boolean>

  Promise that resolves to boolean value indicating whether the enclave is valid

  const isValid = await enclaveAccount.isEnclaveValid();

publicloadData

• loadData(): Promise<any>

• Overrides EnclaveAccount.loadData

  Load Function Account data and update LoadedFunctionAccount state.

  ---

  Returns Promise<any>

  Promise that resolves to EnclaveData

  const functionData = await functionAccount.loadData();

publicpollVerification

• pollVerification(retryCount?: number): Promise<any>

• Inherited from EnclaveAccount.pollVerification

  Method to poll for the enclave verification

  ---

  Parameters

  • optionalretryCount: number = 3

    Number of retries for the operation

  Returns Promise<any>

  Promise that resolves to EnclaveData

  const enclaveData = await enclaveAccount.pollVerification(retryCount);

publictoJSON

• toJSON(): { address: string; authority: string; balance: BigNumber; cid: string; isOnQueue: boolean; lastHeartbeat: number; mrEnclave: string; queueId: string; signer: string; validUntil: number; verificationStatus: PENDING | FAILURE | SUCCESS | OVERRIDE; verificationTimestamp: number }

• Returns { address: string; authority: string; balance: BigNumber; cid: string; isOnQueue: boolean; lastHeartbeat: number; mrEnclave: string; queueId: string; signer: string; validUntil: number; verificationStatus: PENDING | FAILURE | SUCCESS | OVERRIDE; verificationTimestamp: number }

  • address: string

  • authority: string

  • balance: BigNumber

  • cid: string

  • isOnQueue: boolean

  • lastHeartbeat: number

  • mrEnclave: string

  • queueId: string

  • signer: string

  • validUntil: number

  • verificationStatus: PENDING | FAILURE | SUCCESS | OVERRIDE

  • verificationTimestamp: number

publictoObj

• toObj(): { address: string; authority: string; balance: BigNumber; cid: string; isOnQueue: boolean; lastHeartbeat: number; mrEnclave: string; queueId: string; signer: string; validUntil: number; verificationStatus: PENDING | FAILURE | SUCCESS | OVERRIDE; verificationTimestamp: number }

• Returns { address: string; authority: string; balance: BigNumber; cid: string; isOnQueue: boolean; lastHeartbeat: number; mrEnclave: string; queueId: string; signer: string; validUntil: number; verificationStatus: PENDING | FAILURE | SUCCESS | OVERRIDE; verificationTimestamp: number }

  • address: string

  • authority: string

  • balance: BigNumber

  • cid: string

  • isOnQueue: boolean

  • lastHeartbeat: number

  • mrEnclave: string

  • queueId: string

  • signer: string

  • validUntil: number

  • verificationStatus: PENDING | FAILURE | SUCCESS | OVERRIDE

  • verificationTimestamp: number

publicupdateEnclave

• updateEnclave(enclaveBuffer: RawMrEnclave, options?: any): Promise<ContractTransaction>

• Inherited from EnclaveAccount.updateEnclave

  Method to update the enclave

  ---

  Parameters

  • enclaveBuffer: RawMrEnclave

    RawMrEnclave data

  • optionaloptions: any

    Transaction options

  Returns Promise<ContractTransaction>

  Promise that resolves to ContractTransaction

  const contractTransaction = await enclaveAccount.updateEnclave(enclaveBuffer, options);

publicverifyEnclave

• verifyEnclave(verifierAddress: string, mrEnclave: RawMrEnclave, enclaveIdx?: number, options?: any): Promise<ContractTransaction>

• Inherited from EnclaveAccount.verifyEnclave

  Method to verify the enclave

  ---

  Parameters

  • verifierAddress: string

    Address of the verifier

  • mrEnclave: RawMrEnclave

    RawMrEnclave data

  • optionalenclaveIdx: number

    Enclave index

  • optionaloptions: any

    Transaction options

  Returns Promise<ContractTransaction>

  Promise that resolves to ContractTransaction

  const contractTransaction = await enclaveAccount.verifyEnclave(verifierAddress, mrEnclave, enclaveIdx, options);

publicstaticcreate

• create(switchboard: ISwitchboardProgram, params: EnclaveInitParams & { attestationQueue: string }, options?: any): Promise<[EnclaveAccount, ContractTransaction]>

• Inherited from EnclaveAccount.create

  Static method to initialize a Enclave

  ---

  Parameters

  • switchboard: ISwitchboardProgram

    Instance of the SwitchboardProgram class

  • params: EnclaveInitParams & { attestationQueue: string }

    Enclave initialization parameters

  • optionaloptions: any

    Transaction options

  Returns Promise<[EnclaveAccount, ContractTransaction]>

  Promise that resolves to tuple of EnclaveAccount and ContractTransaction

  const [enclaveAccount, contractTransaction] = await EnclaveAccount.create(switchboard, params, options);

publicstaticinitAndAwaitVerification

• initAndAwaitVerification(switchboard: ISwitchboardProgram, authority: string, attestationQueueAddress: string, enclaveBuffer: RawMrEnclave, options?: any, retryCount?: number): Promise<EnclaveAccount>

• Inherited from EnclaveAccount.initAndAwaitVerification

  Static method to initialize and await for the enclave verification

  ---

  Parameters

  • switchboard: ISwitchboardProgram

    Instance of the Switchboard Program class

  • authority: string

    Address of the authority

  • attestationQueueAddress: string

    Attestation Queue Address

  • enclaveBuffer: RawMrEnclave

    RawMrEnclave data

  • optionaloptions: any

    Transaction options

  • optionalretryCount: number = 3

    Number of retries for the operation

  Returns Promise<EnclaveAccount>

  Promise that resolves to EnclaveAccount

  const enclaveAccount = await EnclaveAccount.initAndAwaitVerification(switchboard, authority, attestationQueueAddress, enclaveBuffer, options, retryCount);

publicstaticload

• load(switchboard: ISwitchboardProgram, address: string): Promise<LoadedEnclaveAccount>

• Inherited from EnclaveAccount.load

  Static method to load and fetch the account data

  ---

  Parameters

  • switchboard: ISwitchboardProgram

    Instance of the SwitchboardProgram class

  • address: string

    Address of the EnclaveAccount

  Returns Promise<LoadedEnclaveAccount>

  Promise that resolves to tuple of EnclaveAccount and EnclaveData

  const enclaveAccount = await EnclaveAccount.load(switchboard, address);

publicstaticsignerToAddress

• signerToAddress(switchboard: ISwitchboardProgram, authority: string): Promise<EnclaveAccount>

• Inherited from EnclaveAccount.signerToAddress

  Static method to get the EnclaveAccount for the given authority

  ---

  Parameters

  • switchboard: ISwitchboardProgram

    Instance of the Switchboard Program class

  • authority: string

    Address of the authority

  Returns Promise<EnclaveAccount>

  Promise that resolves to EnclaveAccount

  const enclaveAccount = await EnclaveAccount.signerToAddress(switchboard, authority);