Class WXTZOven

Hierarchy

WXTZBase<WXTZOven>
- WXTZOven

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WXTZOven(ovenAddress: address, wXTZConfig: wXTZConfig, deployment: Deployment): WXTZOven

Overrides WXTZBase.constructor
- Defined in WXTZOven.ts:18
Parameters
- ovenAddress: address
- wXTZConfig: wXTZConfig
- deployment: Deployment
Returns WXTZOven

Properties

Private BCDApi

BCDApi: BCDApi

Protected Tezos

Tezos: TezosToolkit

Protected Readonly deployment

deployment: Deployment

Readonly indexerUrl

indexerUrl: string

Protected instance

instance: ContractAbstraction<ContractProvider | Wallet>

Protected network

network: NetworkType

Methods

checkAddress

checkAddress(): boolean

Inherited from WXTZBase.checkAddress
- Defined in WXTZBase.ts:41
Returns boolean

checkContractCodeIntegrity

checkContractCodeIntegrity(): Promise<boolean>

Inherited from WXTZBase.checkContractCodeIntegrity
- Defined in WXTZBase.ts:34
Returns Promise<boolean>

deposit

deposit(): Promise<ContractMethod<ContractProvider | Wallet>>

- Defined in WXTZOven.ts:61
Provide the amount to be deposited as sendParameter when calling .send() on this ContractMethod.

Returns Promise<ContractMethod<ContractProvider | Wallet>>

getAddress

getAddress(): address

Inherited from WXTZBase.getAddress
- Defined in WXTZBase.ts:30
Returns address

getBalance

getBalance(): Promise<TezosBalance>

- Defined in WXTZOven.ts:53
Returns the XTZ balance of this oven.

Returns Promise<TezosBalance>

getCoreAddress

getCoreAddress(): Promise<address>

- Defined in WXTZOven.ts:25
Returns Promise<address>

getDelegate

getDelegate(): Promise<delegate>

- Defined in WXTZOven.ts:32
Returns baker address this oven has delegated to or null.

Returns Promise<delegate>

getDetails

getDetails(): Promise<contractDetails>

- Defined in WXTZOven.ts:41
Returns Promise<contractDetails>

getLastStates

getLastStates(): Promise<any>

- Defined in WXTZOven.ts:46
Returns Promise<any>

Private getStorage

getStorage(): Promise<OvenContractStorage>

- Defined in WXTZOven.ts:91
Returns Promise<OvenContractStorage>

initialize

initialize(): Promise<WXTZBase<WXTZOven>>

Inherited from WXTZBase.initialize
- Defined in WXTZBase.ts:25
Returns Promise<WXTZBase<WXTZOven>>

removeDelegate

removeDelegate(): Promise<ContractMethod<ContractProvider | Wallet>>

- Defined in WXTZOven.ts:87
Removes delegate for this oven. Need to call .send() on this ContractMethod.

Returns Promise<ContractMethod<ContractProvider | Wallet>>

setDelegate

setDelegate(delegate: delegate): Promise<ContractMethod<ContractProvider | Wallet>>

- Defined in WXTZOven.ts:79
Need to call .send() on this ContractMethod.

Parameters
- delegate: delegate
  
  Provide a registered baker as delegate.
Returns Promise<ContractMethod<ContractProvider | Wallet>>

withdraw

withdraw(amount: mutez): Promise<ContractMethod<ContractProvider | Wallet>>

- Defined in WXTZOven.ts:70
Need to call .send() on this ContractMethod.

Parameters
- amount: mutez
  
  Amount in mutez to withdraw from the oven.
Returns Promise<ContractMethod<ContractProvider | Wallet>>

Generated using TypeDoc