Class WXTZSDK

Hierarchy

WXTZCore
- WXTZSDK

Index

Constructors

constructor

Properties

Methods

Constructors

Private constructor

new WXTZSDK(coreAddress: address, wXTZConfig: wXTZConfig, deployment?: Deployment): WXTZSDK

Overrides WXTZCore.constructor
- Defined in WXTZSDK.ts:11
Parameters
- coreAddress: address
- wXTZConfig: wXTZConfig
- Optional deployment: Deployment
Returns WXTZSDK

Properties

Protected Tezos

Tezos: TezosToolkit

deployment

deployment: Deployment

Readonly indexerUrl

indexerUrl: string

instance

instance: ContractAbstraction<ContractProvider | Wallet>

Protected network

network: NetworkType

token

token: WXTZToken

Private wXTZConfig

wXTZConfig: wXTZConfig

Methods

checkAddress

checkAddress(): boolean

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

checkCodeIntegrity

checkCodeIntegrity(): Promise<boolean>

- Defined in WXTZSDK.ts:35
Returns Promise<boolean>

checkContractCodeIntegrity

checkContractCodeIntegrity(): Promise<boolean>

Inherited from WXTZCore.checkContractCodeIntegrity

Overrides WXTZBase.checkContractCodeIntegrity
- Defined in WXTZCore.ts:33
Returns Promise<boolean>

createOven

createOven(ovenOwner: ovenOwner, delegate?: address): Promise<ContractMethod<ContractProvider | Wallet>>

Inherited from WXTZCore.createOven
- Defined in WXTZCore.ts:53
Need to call .send() on this contract method to invoke the smart contract call. Pass optional XTZ amount as sendParameter in .send().

Parameters
- ovenOwner: ovenOwner
  
  The address of the oven owner.
- Optional delegate: address
  
  The address of the registered baker.
Returns Promise<ContractMethod<ContractProvider | Wallet>>

getAddress

getAddress(): address

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

getAllOvenAddressesByOwner

getAllOvenAddressesByOwner(ovenOwner: ovenOwner): Promise<address[]>

Inherited from WXTZCore.getAllOvenAddressesByOwner
- Defined in WXTZCore.ts:61
Parameters
- ovenOwner: ovenOwner
Returns Promise<address[]>

getAllOvensByOwner

getAllOvensByOwner(ovenOwner: address): Promise<WXTZOven[]>

- Defined in WXTZSDK.ts:41
Parameters
- ovenOwner: address
Returns Promise<WXTZOven[]>

getBalance

getBalance(ovenOwner: address): Promise<WrappedXTZBalance>

- Defined in WXTZSDK.ts:50
Parameters
- ovenOwner: address
Returns Promise<WrappedXTZBalance>

getOwnerAddressForOven

getOwnerAddressForOven(ovenAddress: address): Promise<ovenOwner>

Inherited from WXTZCore.getOwnerAddressForOven
- Defined in WXTZCore.ts:74
Parameters
- ovenAddress: address
Returns Promise<ovenOwner>

getTotalLockedXTZ

getTotalLockedXTZ(ovenOwner: ovenOwner): Promise<TezosBalance>

Inherited from WXTZCore.getTotalLockedXTZ
- Defined in WXTZCore.ts:67
Parameters
- ovenOwner: ovenOwner
Returns Promise<TezosBalance>

getTotalSupply

getTotalSupply(): Promise<WrappedXTZBalance>

- Defined in WXTZSDK.ts:46
Returns Promise<WrappedXTZBalance>

getWXTZTokenContractAddress

getWXTZTokenContractAddress(): Promise<address>

Inherited from WXTZCore.getWXTZTokenContractAddress
- Defined in WXTZCore.ts:39
Returns Promise<address>

initialize

initialize(): Promise<WXTZBase<WXTZCore>>

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

oven

oven(ovenAddress: address): WXTZOven

- Defined in WXTZSDK.ts:21
Parameters
- ovenAddress: address
Returns WXTZOven

Static at

at(coreAddress: address, wXTZConfig: wXTZConfig, deployment?: Deployment): Promise<WXTZSDK>

- Defined in WXTZSDK.ts:25
Parameters
- coreAddress: address
- wXTZConfig: wXTZConfig
- Optional deployment: Deployment
Returns Promise<WXTZSDK>

Generated using TypeDoc