Documentation

Global

Members

# constant ACDevNodes

ACDevNodes
Properties:
Name Type Description
Singapore1 Object Singapore 1
Singapore2 Object Singapore 2
Japan1 Object Japan 1
Japan2 Object Japan 2
HongKong1 Object Hong Kong 1
HongKong2 Object Hong Kong 2

View Source constants.ts, line 64

# constant ACNodes

ACNodes
Properties:
Name Type Description
Singapore1 Object Singapore 1
Singapore2 Object Singapore 2
HongKong1 Object Hong Kong 1
HongKong2 Object Hong Kong 2
Japan1 Object Japan 1
Japan2 Object Japan 2

View Source constants.ts, line 28

string

# Environment

Properties:
Name Type Description
Production string 'production'
Development string 'development'

View Source constants.ts, line 95

string

# constant NetworkSymbol

Networks
Properties:
Name Type Description
Ethereum_Mainnet string 'ETH'
Ethereum_Sepolia string 'SEP'
Tron string 'TRX'
Tron_Shasta string 'TRX-SHASTA'

View Source types.ts, line 22

string

# TokenSymbol

Tokens
Properties:
Name Type Description
USDT string 'USDT'
TETHER string UNUSED - For testing purposes only

View Source types.ts, line 38

string

# TransactionLayer

Properties:
Name Type Description
L1 string 'L1Transaction'
L2 string 'L2Transaction'

View Source types.ts, line 50

string

# TransactionResult

Properties:
Name Type Description
SUCCESS string 'Success'
FAILURE string 'Failure'

View Source types.ts, line 74

string

# TransactionStatus

Properties:
Name Type Description
PENDING string 'Pending'
CONFIRMED string 'Confirmed'
FAILED string 'Failed'

View Source types.ts, line 62

string

# TransactionType

Properties:
Name Type Description
DEPOSIT string 'Deposit'
WITHDRAWAL string 'Withdrawal'

View Source types.ts, line 85

Type Definitions

APBuilderArgs.<Environment>

# APBuilderArgs

Properties:
Name Type Attributes Description
logger ILogger <optional>
environment Environment <optional>
 Defaults to Environment.Production
targetNode ACNode | ACDevNode <optional>
 Dependent on environment
recoveryPhrase string <optional>
 Supply this or privateKey
privateKey string <optional>
 Supply this or recoveryPhrase
l2Address string <optional>

View Source types.ts, line 346

object

# OTKPair

OtkPair
Properties:
Name Type Attributes Description
recoveryPhrase string <optional>
 Supply this or privateKey
privateKey string <optional>
 Supply this or recoveryPhrase
l2Address string

View Source types.ts, line 338