IExecVoucherModule.md

iexec / Exports / IExecVoucherModule

Class: IExecVoucherModule

module exposing voucher methods

Hierarchy

• IExecModule

  ↳ IExecVoucherModule

Table of contents

Constructors

• constructor

Properties

• config

Methods

• authorizeRequester
• getVoucherAddress
• revokeRequesterAuthorization
• showUserVoucher
• fromConfig

Constructors

constructor

• new IExecVoucherModule(configOrArgs, options?): IExecVoucherModule

Create an IExecModule instance

Parameters

Name	Type
configOrArgs	IExecConfig | IExecConfigArgs
options?	IExecConfigOptions

Returns

IExecVoucherModule

Inherited from

IExecModule.constructor

Properties

config

• config: IExecConfig

current IExecConfig

Inherited from

IExecModule.config

Methods

authorizeRequester

▸ authorizeRequester(requester): Promise<string>

SIGNER REQUIRED

authorize a requester to use the voucher

example:

const txHash = await authorizeRequester(requesterAddress);
console.log('tx:', txHash);

Parameters

Name	Type
requester	string

Returns

Promise<string>

---

getVoucherAddress

▸ getVoucherAddress(owner): Promise<null | string>

returns the address of the voucher contract for the specified address if the address owns a voucher

example:

const voucherAddress = await getVoucherAddress(ownerAddress);
console.log('voucher contract address:', voucherAddress);

Parameters

Name	Type
owner	string

Returns

Promise<null | string>

---

revokeRequesterAuthorization

▸ revokeRequesterAuthorization(requester): Promise<string>

Parameters

Name	Type
requester	string

Returns

Promise<string>

---

showUserVoucher

▸ showUserVoucher(owner): Promise<VoucherInfo>

returns the user voucher information

example:

const userVoucher = await showUserVoucher(userAddress);
console.log('address:', userVoucher.address);
console.log('balance:', userVoucher.balance);
console.log('expiration:', userVoucher.expirationTimestamp);
console.log('sponsored apps:', userVoucher.sponsoredApps);
console.log('sponsored datasets:', userVoucher.sponsoredDatasets);
console.log('sponsored workerpools:', userVoucher.sponsoredWorkerpools);
console.log('allowance on user account:', userVoucher.allowanceAmount);
console.log('authorized accounts:', userVoucher.authorizedAccounts);

Parameters

Name	Type
owner	string

Returns

Promise<VoucherInfo>

---

fromConfig

▸ fromConfig(config): IExecVoucherModule

Create an IExecVoucherModule instance using an IExecConfig instance

Parameters

Name	Type
config	IExecConfig

Returns

IExecVoucherModule

Overrides

IExecModule.fromConfig