index.md

zilswap-sdk / Exports / index

Module: index

Table of contents

References

• Zilo

Classes

• Zilswap

Type aliases

• AppState
• ContractState
• ObservedTx
• OnUpdate
• Options
• Pool
• Rates
• TokenDetails
• TxParams
• TxReceipt
• TxStatus
• WalletProvider

References

Zilo

Renames and exports: zilo

Type aliases

AppState

Ƭ AppState: Object

Type declaration

Name	Type
contractState	ContractState
currentBalance	BigNumber | null
currentNonce	number | null
currentUser	string | null
pools	{ [key in string]?: Pool}
tokens	{ [key in string]: TokenDetails}

Defined in

index.ts:64

---

ContractState

Ƭ ContractState: Object

Type declaration

Name	Type
balances	{ [key in string]?: { [key2 in string]?: string}}
output_after_fee	string
pools	{ [key in string]?: object}
total_contributions	{ [key in string]?: string}

Defined in

index.ts:57

---

ObservedTx

Ƭ ObservedTx: Object

Type declaration

Name	Type
deadline	number
hash	string

Defined in

index.ts:28

---

OnUpdate

Ƭ OnUpdate: (tx: ObservedTx, status: TxStatus, receipt?: TxReceipt) => void

Type declaration

▸ (tx, status, receipt?): void

Parameters

Name	Type
tx	ObservedTx
status	TxStatus
receipt?	TxReceipt

Returns

void

Defined in

index.ts:26

---

Options

Ƭ Options: Object

Type declaration

Name	Type
deadlineBuffer?	number
gasLimit?	number
gasPrice?	number
rpcEndpoint?	string

Defined in

index.ts:19

---

Pool

Ƭ Pool: Object

Type declaration

Name	Type
contributionPercentage	BigNumber
exchangeRate	BigNumber
tokenReserve	BigNumber
totalContribution	BigNumber
userContribution	BigNumber
zilReserve	BigNumber

Defined in

index.ts:73

---

Rates

Ƭ Rates: Object

Type declaration

Name	Type
expectedAmount	BigNumber
slippage	BigNumber

Defined in

index.ts:82

---

TokenDetails

Ƭ TokenDetails: Object

Type declaration

Name	Type
address	string
contract	Contract
decimals	number
hash	string
registered	boolean
symbol	string
whitelisted	boolean

Defined in

index.ts:47

---

TxParams

Ƭ TxParams: Object

Type declaration

Name	Type
gasLimit	Long
gasPrice	BN
version	number

Defined in

index.ts:41

---

TxReceipt

Ƭ TxReceipt: \_TxReceipt

Defined in

index.ts:39

---

TxStatus

Ƭ TxStatus: "confirmed" | "rejected" | "expired"

Defined in

index.ts:37

---

WalletProvider

Ƭ WalletProvider: Omit<Zilliqa & { wallet: Wallet & { defaultAccount: { base16: string ; bech32: string } ; net: string } }, "subscriptionBuilder">

Defined in

index.ts:87