Orderly SDKs / Modules / @orderly.network/types

Module: @orderly.network/types

References

Chain

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

isNativeTokenChecker

References

Chain

Renames and re-exports ChainConfig

Type Aliases

AlgoOrderEntity

Type parameters

Name	Type
`T`	extends `AlgoOrderRootType` = `STOP`

Defined in

packages/types/src/order.ts:116

CurrentChain

Ƭ CurrentChain: Object

Type declaration

Name	Type
`id`	`number`
`info`	`Chain`

Defined in

packages/types/src/wallet.ts:8

NetworkId

Ƭ NetworkId: "testnet" | "mainnet"

Defined in

packages/types/src/constants.ts:21

Optional

Ƭ Optional<T, K>: Omit<T, K> & Partial<Pick<T, K>>

Type parameters

Name	Type
`T`	`T`
`K`	extends keyof `T`

Defined in

packages/types/src/order.ts:84

RequireKeys

Ƭ RequireKeys<T, K>: Required<Pick<T, K>> & Omit<T, K>

Type parameters

Name	Type
`T`	extends `object`
`K`	extends keyof `T`

Defined in

packages/types/src/order.ts:85

TPSLOrderEntry

Ƭ TPSLOrderEntry: Optional<AlgoOrderEntity<TP_SL>, "side" | "type" | "trigger_price">

Defined in

packages/types/src/order.ts:130

Variables

ARBITRUM_MAINNET_CHAINID

• Const ARBITRUM_MAINNET_CHAINID: 42161

Defined in

packages/types/src/constants.ts:36

ARBITRUM_MAINNET_CHAINID_HEX

• Const ARBITRUM_MAINNET_CHAINID_HEX: "0xa4b1"

Defined in

packages/types/src/constants.ts:37

ARBITRUM_TESTNET_CHAINID

• Const ARBITRUM_TESTNET_CHAINID: 421614

Defined in

packages/types/src/constants.ts:29

ARBITRUM_TESTNET_CHAINID_HEX

• Const ARBITRUM_TESTNET_CHAINID_HEX: "0x66EEE"

Defined in

packages/types/src/constants.ts:30

Arbitrum

• Const Arbitrum: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Arbitrum”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:173

ArbitrumGoerli

• Const ArbitrumGoerli: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Arbitrum Goerli”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “AGOR”; `symbol`: `string` = “AGOR” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “AGOR”; `symbol`: `string` = “AGOR” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:346

ArbitrumSepolia

• Const ArbitrumSepolia: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Arbitrum Sepolia”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:370

Avalanche

• Const Avalanche: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Avalanche”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 5; `name`: `string` = “avax”; `symbol`: `string` = “AVAX” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 5; `name`: `string` = “avax”; `symbol`: `string` = “AVAX” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:53

BNB

• Const BNB: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “BNB Chain”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 6; `name`: `string` = “bnb”; `symbol`: `string` = “BNB” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 6; `name`: `string` = “bnb”; `symbol`: `string` = “BNB” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:101

Base

• Const Base: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Base Network”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:298

BaseSepolia

• Const BaseSepolia: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Base Sepolia”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:442

DEPOSIT_FEE_RATE

• Const DEPOSIT_FEE_RATE: 1.05

Defined in

packages/types/src/constants.ts:41

Ethereum

• Const Ethereum: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Ethereum Mainnet”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 8; `name`: `string` = “eth”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 8; `name`: `string` = “eth”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:29

Fantom

• Const Fantom: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Fantom”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ftm”; `symbol`: `string` = “FTM” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ftm”; `symbol`: `string` = “FTM” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:125

Fuji

• Const Fuji: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Avalanche Fuji Testnet”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 5; `name`: `string` = “avax”; `symbol`: `string` = “AVAX” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 5; `name`: `string` = “avax”; `symbol`: `string` = “AVAX” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:77

Linea

• Const Linea: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Linea”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:274

MANTLE_TESTNET_CHAINID

• Const MANTLE_TESTNET_CHAINID: 5003

Defined in

packages/types/src/constants.ts:32

MANTLE_TESTNET_CHAINID_HEX

• Const MANTLE_TESTNET_CHAINID_HEX: "0x138b"

Defined in

packages/types/src/constants.ts:33

MEDIA_TABLET

• Const MEDIA_TABLET: "(max-width: 768px)"

Defined in

packages/types/src/constants.ts:39

Mantle

• Const Mantle: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Mantle”; `nativeCurrency`: { `decimals`: `number` = 6; `fix`: `number` = 4; `name`: `string` = “MNT”; `symbol`: `string` = “MNT” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 6; `fix`: `number` = 4; `name`: `string` = “MNT”; `symbol`: `string` = “MNT” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:322

MantleSepolia

• Const MantleSepolia: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Mantle Sepolia”; `nativeCurrency`: { `decimals`: `number` = 6; `fix`: `number` = 4; `name`: `string` = “MNT”; `symbol`: `string` = “MNT” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 6; `fix`: `number` = 4; `name`: `string` = “MNT”; `symbol`: `string` = “MNT” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:466

MaxUint256

• Const MaxUint256: bigint

A constant for the maximum value for a uint256.

Defined in

packages/types/src/constants.ts:46

Optimism

• Const Optimism: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Optimism”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:197

OptimismGoerli

• Const OptimismGoerli: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Optimism Goerli”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:394

OptimismSepolia

• Const OptimismSepolia: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Optimism Sepolia”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “ETH”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:418

Polygon

• Const Polygon: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Polygon”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “matic”; `symbol`: `string` = “MATIC” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “matic”; `symbol`: `string` = “MATIC” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:149

PolygonAmoy

• Const PolygonAmoy: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Polygon Amoy”; `nativeCurrency`: { `decimals`: `number` = 6; `fix`: `number` = 4; `name`: `string` = “MATIC”; `symbol`: `string` = “MATIC” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 6; `fix`: `number` = 4; `name`: `string` = “MATIC”; `symbol`: `string` = “MATIC” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:490

PolygonzkEVM

• Const PolygonzkEVM: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “Polygon zkEVM”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:250

TestnetChains

• Const TestnetChains: { network_infos: { bridge_enable: boolean = true; chain_id: number = 421614; currency_symbol: string = “ETH”; est_txn_mins: null = null; explorer_base_url: string = ”https://sepolia.arbiscan.io“; mainnet: boolean = false; name: string = “Arbitrum Sepolia”; public_rpc_url: string = ”https://arbitrum-sepolia.blockpi.network/v1/rpc/public“; shortName: string = “Arbitrum Sepolia” } ; token_infos: { address: string = “0x75faf114eafb1BDbe2F0316DF893fd58CE46AA4d”; decimals: number = 6; symbol: string = “USDC” }[] }[]

Defined in

packages/types/src/chains.ts:537

chainsInfoMap

• Const chainsInfoMap: Map<number, ChainConfig>

Defined in

packages/types/src/chains.ts:514

defaultMainnetChains

• Const defaultMainnetChains: { blockExplorerName: string = “Arbiscan”; chainInfo: { blockExplorerUrls: string[] ; chainId: string ; chainName: string = “Arbitrum”; nativeCurrency: { decimals: number = 18; fix: number = 4; name: string = “eth”; symbol: string = “ETH” } ; rpcUrls: string[] } ; chainLogo: string = ""; chainName: string = “Arbitrum”; chainNameShort: string = “Arbitrum”; id: number = 42161; maxPrepayCrossGas: number = 0.03; minCrossGasBalance: number = 0.002; minGasBalance: number = 0.0002; requestRpc: string = ”https://arb1.arbitrum.io/rpc” }[]

Defined in

packages/types/src/chains.ts:614

defaultTestnetChains

• Const defaultTestnetChains: { blockExplorerName: string = “Arbitrum Sepolia”; chainInfo: { blockExplorerUrls: string[] ; chainId: string ; chainName: string = “Arbitrum Sepolia”; nativeCurrency: { decimals: number = 18; fix: number = 4; name: string = “ETH”; symbol: string = “ETH” } ; rpcUrls: string[] } ; chainLogo: string = ""; chainName: string = “Arbitrum Sepolia”; chainNameShort: string = “Arbitrum Sepolia”; id: number = 421614; maxPrepayCrossGas: number = 0.03; minCrossGasBalance: number = 0.002; minGasBalance: number = 0.0002; requestRpc: string = ”https://arbitrum-sepolia.blockpi.network/v1/rpc/public” }[]

Defined in

packages/types/src/chains.ts:615

definedTypes

• Const definedTypes: Object

Type declaration

Name	Type
`AddOrderlyKey`	readonly [{ `name`: `"brokerId"` = “brokerId”; `type`: `"string"` = “string” }, { `name`: `"chainId"` = “chainId”; `type`: `"uint256"` = “uint256” }, { `name`: `"orderlyKey"` = “orderlyKey”; `type`: `"string"` = “string” }, { `name`: `"scope"` = “scope”; `type`: `"string"` = “string” }, { `name`: `"timestamp"` = “timestamp”; `type`: `"uint64"` = “uint64” }, { `name`: `"expiration"` = “expiration”; `type`: `"uint64"` = “uint64” }]
`EIP712Domain`	readonly [{ `name`: `"name"` = “name”; `type`: `"string"` = “string” }, { `name`: `"version"` = “version”; `type`: `"string"` = “string” }, { `name`: `"chainId"` = “chainId”; `type`: `"uint256"` = “uint256” }, { `name`: `"verifyingContract"` = “verifyingContract”; `type`: `"address"` = “address” }]
`Registration`	readonly [{ `name`: `"brokerId"` = “brokerId”; `type`: `"string"` = “string” }, { `name`: `"chainId"` = “chainId”; `type`: `"uint256"` = “uint256” }, { `name`: `"timestamp"` = “timestamp”; `type`: `"uint64"` = “uint64” }, { `name`: `"registrationNonce"` = “registrationNonce”; `type`: `"uint256"` = “uint256” }]
`SettlePnl`	readonly [{ `name`: `"brokerId"` = “brokerId”; `type`: `"string"` = “string” }, { `name`: `"chainId"` = “chainId”; `type`: `"uint256"` = “uint256” }, { `name`: `"settleNonce"` = “settleNonce”; `type`: `"uint64"` = “uint64” }, { `name`: `"timestamp"` = “timestamp”; `type`: `"uint64"` = “uint64” }]
`Withdraw`	readonly [{ `name`: `"brokerId"` = “brokerId”; `type`: `"string"` = “string” }, { `name`: `"chainId"` = “chainId”; `type`: `"uint256"` = “uint256” }, { `name`: `"receiver"` = “receiver”; `type`: `"address"` = “address” }, { `name`: `"token"` = “token”; `type`: `"string"` = “string” }, { `name`: `"amount"` = “amount”; `type`: `"uint256"` = “uint256” }, { `name`: `"withdrawNonce"` = “withdrawNonce”; `type`: `"uint64"` = “uint64” }, { `name`: `"timestamp"` = “timestamp”; `type`: `"uint64"` = “uint64” }]

Defined in

packages/types/src/sign.ts:1

nativeTokenAddress

• Const nativeTokenAddress: "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE"

Defined in

packages/types/src/constants.ts:50

version

• version: "1.5.7"

Defined in

packages/types/src/version.ts:14

zkSyncEra

• Const zkSyncEra: Object

Type declaration

Name	Type
`blockExplorerName`	`string`
`chainInfo`	{ `blockExplorerUrls`: `string`[] ; `chainId`: `string` ; `chainName`: `string` = “zkSync Era”; `nativeCurrency`: { `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” } ; `rpcUrls`: `string`[] }
`chainInfo.blockExplorerUrls`	`string`[]
`chainInfo.chainId`	`string`
`chainInfo.chainName`	`string`
`chainInfo.nativeCurrency`	{ `decimals`: `number` = 18; `fix`: `number` = 4; `name`: `string` = “eth”; `symbol`: `string` = “ETH” }
`chainInfo.nativeCurrency.decimals`	`number`
`chainInfo.nativeCurrency.fix`	`number`
`chainInfo.nativeCurrency.name`	`string`
`chainInfo.nativeCurrency.symbol`	`string`
`chainInfo.rpcUrls`	`string`[]
`chainLogo`	`string`
`chainName`	`string`
`chainNameShort`	`string`
`id`	`number`
`maxPrepayCrossGas`	`number`
`minCrossGasBalance`	`number`
`minGasBalance`	`number`
`requestRpc`	`string`

Defined in

packages/types/src/chains.ts:221

Functions

isNativeTokenChecker

▸ isNativeTokenChecker(address): boolean

Parameters

Name	Type
`address`	`string`

Returns

boolean

Defined in

packages/types/src/constants.ts:52

Orderly network types.WSMessage Orderly network core.AccountState

On this page

Module: @orderly.network/types
Table of contents
References
Namespaces
Enumerations
Classes
Interfaces
Type Aliases
Variables
Functions
References
Chain
Type Aliases
AlgoOrderEntity
Type parameters
Defined in
CurrentChain
Type declaration
Defined in
NetworkId
Defined in
Optional
Type parameters
Defined in
RequireKeys
Type parameters
Defined in
TPSLOrderEntry
Defined in
Variables
ARBITRUM_MAINNET_CHAINID
Defined in
ARBITRUM_MAINNET_CHAINID_HEX
Defined in
ARBITRUM_TESTNET_CHAINID
Defined in
ARBITRUM_TESTNET_CHAINID_HEX
Defined in
Arbitrum
Type declaration
Defined in
ArbitrumGoerli
Type declaration
Defined in
ArbitrumSepolia
Type declaration
Defined in
Avalanche
Type declaration
Defined in
BNB
Type declaration
Defined in
Base
Type declaration
Defined in
BaseSepolia
Type declaration
Defined in
DEPOSIT_FEE_RATE
Defined in
Ethereum
Type declaration
Defined in
Fantom
Type declaration
Defined in
Fuji
Type declaration
Defined in
Linea
Type declaration
Defined in
MANTLE_TESTNET_CHAINID
Defined in
MANTLE_TESTNET_CHAINID_HEX
Defined in
MEDIA_TABLET
Defined in
Mantle
Type declaration
Defined in
MantleSepolia
Type declaration
Defined in
MaxUint256
Defined in
Optimism
Type declaration
Defined in
OptimismGoerli
Type declaration
Defined in
OptimismSepolia
Type declaration
Defined in
Polygon
Type declaration
Defined in
PolygonAmoy
Type declaration
Defined in
PolygonzkEVM
Type declaration
Defined in
TestnetChains
Defined in
chainsInfoMap
Defined in
defaultMainnetChains
Defined in
defaultTestnetChains
Defined in
definedTypes
Type declaration
Defined in
nativeTokenAddress
Defined in
version
Defined in
zkSyncEra
Type declaration
Defined in
Functions
isNativeTokenChecker
Parameters
Returns
Defined in

Software Development Kits

[EVM] React Components SDK

[EVM] React Hooks SDK

[EVM] Core SDK

[EVM] Perp SDK

Technical Documentation

​Module: @orderly.network/types

​Table of contents

​References

​Namespaces

​Enumerations

​Classes

​Interfaces

​Type Aliases

​Variables

​Functions

​References

​Chain

​Type Aliases

​AlgoOrderEntity

​Type parameters

​Defined in

​CurrentChain

​Type declaration

​Defined in

​NetworkId

​Defined in

​Optional

​Type parameters

​Defined in

​RequireKeys

​Type parameters

​Defined in

​TPSLOrderEntry

​Defined in

​Variables

​ARBITRUM_MAINNET_CHAINID

​Defined in

​ARBITRUM_MAINNET_CHAINID_HEX

​Defined in

​ARBITRUM_TESTNET_CHAINID

​Defined in

​ARBITRUM_TESTNET_CHAINID_HEX

​Defined in

​Arbitrum

​Type declaration

​Defined in

​ArbitrumGoerli

​Type declaration

​Defined in

​ArbitrumSepolia

​Type declaration

​Defined in

​Avalanche

​Type declaration

​Defined in

​BNB

​Type declaration

​Defined in

​Base

​Type declaration

​Defined in

​BaseSepolia

​Type declaration

​Defined in

​DEPOSIT_FEE_RATE

​Defined in

​Ethereum

​Type declaration

​Defined in

​Fantom

​Type declaration

​Defined in

​Fuji

​Type declaration

​Defined in

​Linea

​Type declaration

​Defined in

​MANTLE_TESTNET_CHAINID

Module: @orderly.network/types

Table of contents

References

Namespaces

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

Chain

Type Aliases

AlgoOrderEntity

Type parameters

Defined in

CurrentChain

Type declaration

Defined in

NetworkId

Defined in

Optional

Type parameters

Defined in

RequireKeys

Type parameters

Defined in

TPSLOrderEntry

Defined in

Variables

ARBITRUM_MAINNET_CHAINID

Defined in

ARBITRUM_MAINNET_CHAINID_HEX

Defined in

ARBITRUM_TESTNET_CHAINID

Defined in

ARBITRUM_TESTNET_CHAINID_HEX

Defined in

Arbitrum

Type declaration

Defined in

ArbitrumGoerli

Type declaration

Defined in

ArbitrumSepolia

Type declaration

Defined in

Avalanche

Type declaration

Defined in

BNB

Type declaration

Defined in

Base

Type declaration

Defined in

BaseSepolia

Type declaration

Defined in

DEPOSIT_FEE_RATE

Defined in

Ethereum

Type declaration

Defined in

Fantom

Type declaration

Defined in

Fuji

Type declaration

Defined in

Linea

Type declaration

Defined in

MANTLE_TESTNET_CHAINID

Defined in

MANTLE_TESTNET_CHAINID_HEX

Defined in

MEDIA_TABLET

Defined in

Mantle