Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DetherJS

classdesc

This is the main detherJS object You can Use it like this

Hierarchy

  • DetherJS

Index

Constructors

constructor

  • new DetherJS(useMetamask: boolean): DetherJS

Properties

dthContract

dthContract: Contract

encryptedWallet

encryptedWallet: string

geoRegistryContract

geoRegistryContract: Contract

network

network: any

provider

provider: any

shopsContract

shopsContract: Contract

usingMetamask

usingMetamask: boolean

zoneFactoryContract

zoneFactoryContract: Contract

Methods

addShop

  • addShop(password: string, shopData: IShopArgs, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • shopData: IShopArgs
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

addTeller

  • addTeller(password: string, tellerData: ITellerArgs, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • tellerData: ITellerArgs
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

addTellerComment

  • addTellerComment(password: string, zoneGeohash: string, ipfsHash: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • zoneGeohash: string
    • ipfsHash: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

approveToken

  • approveToken(password: string, token: Token, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • token: Token
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

bidZone

  • bidZone(password: string, geohash6: string, bidAmount: number, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • bidAmount: number
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

claimFreeZone

  • claimFreeZone(password: string, geohash6: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

collectShopTaxes

  • collectShopTaxes(password: string, geohash6: string, start: number, end: number, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • start: number
    • end: number
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

createZone

  • createZone(password: string, country: string, geohash6: string, amount: number, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • country: string
    • geohash6: string
    • amount: number
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

deleteUserShop

  • deleteUserShop(password: string, geohash6: string, shopAddress: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • shopAddress: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

execExchange

  • execExchange(password: string, sellToken: Token, buyToken: Token, sellAmount: string, buyAmount: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • sellToken: Token
    • buyToken: Token
    • sellAmount: string
    • buyAmount: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

execExchangeFromSell

  • execExchangeFromSell(password: string, buyToken: Token, sellAmount: string, buyAmount: string, destAddress: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • buyToken: Token
    • sellAmount: string
    • buyAmount: string
    • destAddress: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

execExchange_delayed

  • execExchange_delayed(password: string, sellToken: Token, buyToken: Token, sellAmount: string, buyAmount: string, nonce: number, txOptions?: ITxOptions): Promise<any>
  • Parameters

    • password: string
    • sellToken: Token
    • buyToken: Token
    • sellAmount: string
    • buyAmount: string
    • nonce: number
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<any>

getAllBalance

getAvailableToken

  • getAvailableToken(forLogo?: false): Promise<ITicker>

getAvailableTokenDecimals

  • getAvailableTokenDecimals(forLogo?: false): Promise<any>
  • Parameters

    • Optional forLogo: false

    Returns Promise<any>

getERC20Info

  • getERC20Info(address: string): Promise<ITicker>

getExchangeEstimation

  • getExchangeEstimation(sellToken: Token, buyToken: Token, sellAmount: string): Promise<string>

getLicencePriceInZone

  • getLicencePriceInZone(geohash6: string): Promise<string>
  • Parameters

    • geohash6: string

    Returns Promise<string>

getOpenBid

  • getOpenBid(address: string): Promise<any>
  • Parameters

    • address: string

    Returns Promise<any>

getShopByAddress

  • getShopByAddress(shopAddress: string): Promise<IShop>

getShopByPosition

  • getShopByPosition(geohash12: string): Promise<IShop>

getShopsInZone

  • getShopsInZone(geohash6: string): Promise<IShop[]>

getShopsInZones

  • getShopsInZones(geohash6List: string[]): Promise<IShop[][]>

getTeller

  • getTeller(address: string): Promise<any>
  • Parameters

    • address: string

    Returns Promise<any>

getTellerInZone

  • getTellerInZone(geohash6: string): Promise<any>
  • Parameters

    • geohash6: string

    Returns Promise<any>

getTellersInZones

  • getTellersInZones(geohash6List: string[]): Promise<any[]>
  • Parameters

    • geohash6List: string[]

    Returns Promise<any[]>

getTokenLiquidity

  • getTokenLiquidity(tokenAddress: string, txOptions?: ITxOptions): Promise<any>
  • Parameters

    • tokenAddress: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<any>

getTransactionStatus

getZoneByAddress

  • getZoneByAddress(address: string): Promise<IZone>

getZoneByGeohash

  • getZoneByGeohash(geohash6: string): Promise<IZone>

getZonesStatus

  • getZonesStatus(geohash6List: string[]): Promise<any[]>
  • Parameters

    • geohash6List: string[]

    Returns Promise<any[]>

hasApproval

  • hasApproval(owner: string, sellToken: Token, amount: string): Promise<boolean>
  • Parameters

    • owner: string
    • sellToken: Token
    • amount: string

    Returns Promise<boolean>

Private hasProvider

  • hasProvider(): void

Private hasWallet

  • hasWallet(): void

init

initProvider

isBidderOnthisAuction

  • isBidderOnthisAuction(zoneAddress: string, ethAddress: string, auctionID: number): Promise<number>
  • Parameters

    • zoneAddress: string
    • ethAddress: string
    • auctionID: number

    Returns Promise<number>

isTeller

  • isTeller(address: string): Promise<any>
  • Parameters

    • address: string

    Returns Promise<any>

isZoneOpened

  • isZoneOpened(geohash6: string, country: string): Promise<Boolean>
  • Parameters

    • geohash6: string
    • country: string

    Returns Promise<Boolean>

isZoneOwned

  • isZoneOwned(geohash6: string): Promise<Boolean>
  • Parameters

    • geohash6: string

    Returns Promise<Boolean>

isZoneOwner

  • isZoneOwner(address: string): Promise<any>
  • Parameters

    • address: string

    Returns Promise<any>

loadUser

  • loadUser(encryptedWallet: string): void
  • Parameters

    • encryptedWallet: string

    Returns void

Private loadWallet

  • loadWallet(password?: string): Promise<Wallet>
  • Parameters

    • Optional password: string

    Returns Promise<Wallet>

processState

  • processState(password: string, zoneAddress: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • zoneAddress: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

releaseZone

  • releaseZone(password: string, geohash6: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

removeShop

  • removeShop(password: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

removeTeller

  • removeTeller(password: string, zoneGeohash: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • zoneGeohash: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

sendCrypto

  • sendCrypto(password: string, toAddress: string, token: Token, amount: string, tokenAddress?: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • toAddress: string
    • token: Token
    • amount: string
    • Default value tokenAddress: string = constants.ADDRESS_ZERO
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

setCustomContractAddresses

  • setCustomContractAddresses(contractAddresses: any): Promise<void>
  • Parameters

    • contractAddresses: any

    Returns Promise<void>

setShopLicencePrice

  • setShopLicencePrice(password: string, geohash6: string, newPrice: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • newPrice: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

shopExistsByAddress

  • shopExistsByAddress(shopAddress: string): Promise<boolean>
  • Parameters

    • shopAddress: string

    Returns Promise<boolean>

signMessage

  • signMessage(password: string, message: string): Promise<string>
  • Parameters

    • password: string
    • message: string

    Returns Promise<string>

topUpShop

  • topUpShop(password: string, topUpAmount: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • topUpAmount: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

topUpZone

  • topUpZone(password: string, geohash6: string, topUpAmount: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • topUpAmount: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

updateTeller

  • updateTeller(password: string, tellerData: ITellerArgs, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • tellerData: ITellerArgs
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

withdrawAuctionsRaw

  • withdrawAuctionsRaw(password: string, zoneAddress: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • zoneAddress: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

withdrawZoneAuctionBid

  • withdrawZoneAuctionBid(password: string, geohash6: string, auctionId: number, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • auctionId: number
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

withdrawZoneAuctionBidAddress

  • withdrawZoneAuctionBidAddress(password: string, zoneAddress: string, auctionId: number, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • zoneAddress: string
    • auctionId: number
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

withdrawZoneAuctionsBid

  • withdrawZoneAuctionsBid(password: string, geohash6: string, auctionIds: number[], txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • auctionIds: number[]
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

withdrawZoneAuctionsBidAddress

  • withdrawZoneAuctionsBidAddress(password: string, zoneAddress: string, auctionIds: number[], txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • zoneAddress: string
    • auctionIds: number[]
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

withdrawZoneOwnerDth

  • withdrawZoneOwnerDth(password: string, geohash6: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • geohash6: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

withdrawZoneOwnerDthAddress

  • withdrawZoneOwnerDthAddress(password: string, zoneAddress: string, txOptions?: ITxOptions): Promise<ContractTransaction>
  • Parameters

    • password: string
    • zoneAddress: string
    • Default value txOptions: ITxOptions = constants.DEFAULT_TX_OPTIONS

    Returns Promise<ContractTransaction>

Generated using TypeDoc