Gateway.md

StarkEx JavaScript Client Library - v0.0.6 / Exports / Gateway

Class: Gateway

Hierarchy

• GatewayBase

  ↳ Gateway

Table of contents

Constructors

• constructor

Methods

• conditionalTransfer
• deposit
• falseFullWithdrawal
• fullWithdrawal
• getFirstUnusedTxId
• getStarkDexAddress
• getTransaction
• isAlive
• mint
• settlement
• transfer
• withdrawal

Constructors

constructor

• new Gateway(config)

Parameters

Name	Type
config	StarkExClientConfig

Overrides

GatewayBase.constructor

Defined in

gateway/gateway.ts:17

Methods

conditionalTransfer

▸ conditionalTransfer(request): Promise<Record<string, string>>

Parameters

Name	Type
request	ConditionalTransferRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:63

---

deposit

▸ deposit(request): Promise<Record<string, string>>

Parameters

Name	Type
request	TransactionRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:45

---

falseFullWithdrawal

▸ falseFullWithdrawal(request): Promise<Record<string, string>>

Parameters

Name	Type
request	FalseFullWithdrawalRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:81

---

fullWithdrawal

▸ fullWithdrawal(request): Promise<Record<string, string>>

Parameters

Name	Type
request	FullWithdrawalRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:72

---

getFirstUnusedTxId

▸ getFirstUnusedTxId(): Promise<number>

Returns

Promise<number>

Defined in

gateway/gateway.ts:31

---

getStarkDexAddress

▸ getStarkDexAddress(): Promise<string>

Returns

Promise<string>

Defined in

gateway/gateway.ts:27

---

getTransaction

▸ getTransaction(txId): Promise<Record<string, any>>

Parameters

Name	Type
txId	number

Returns

Promise<Record<string, any>>

Defined in

gateway/gateway.ts:21

---

isAlive

▸ isAlive(): Promise<string>

Returns

Promise<string>

Defined in

gateway/gateway.ts:35

---

mint

▸ mint(request): Promise<Record<string, string>>

Parameters

Name	Type
request	TransactionRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:49

---

settlement

▸ settlement(request): Promise<Record<string, string>>

Parameters

Name	Type
request	SettlementRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:53

---

transfer

▸ transfer(request): Promise<Record<string, string>>

Parameters

Name	Type
request	TransferRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:59

---

withdrawal

▸ withdrawal(request): Promise<Record<string, string>>

Parameters

Name	Type
request	TransactionRequest

Returns

Promise<Record<string, string>>

Defined in

gateway/gateway.ts:39