deepbookpy.custom_types package

Submodules

deepbookpy.custom_types.serialization_types module

Module contents

class deepbookpy.custom_types.Coin(address: str, type: str, scalar: int)

Bases: object

address: str

scalar: int

type: str

class deepbookpy.custom_types.CreatePermissionlessPoolParams(base_coin_key: str, quote_coin_key: str, tick_size: int, lot_size: int, min_size: int, deep_coin: ForwardRef('TransactionObjectArgument') | None = None)

Bases: object

base_coin_key: str

deep_coin: TransactionObjectArgument | None = None

lot_size: int

min_size: int

quote_coin_key: str

tick_size: int

class deepbookpy.custom_types.CreatePoolAdminParams(base_coin_key: str, quote_coin_key: str, tick_size: int, lot_size: int, min_size: int, whitelisted: bool, stable_pool: bool, deep_coin: object | None = None, base_coin: object | None = None)

Bases: object

base_coin: object | None = None

base_coin_key: str

deep_coin: object | None = None

lot_size: int

min_size: int

quote_coin_key: str

stable_pool: bool

tick_size: int

whitelisted: bool

class deepbookpy.custom_types.OrderType(value)

Bases: Enum

An enumeration.

FILL_OR_KILL = 2

IMMEDIATE_OR_CANCEL = 1

NO_RESTRICTION = 0

POST_ONLY = 3

class deepbookpy.custom_types.PlaceLimitOrderParams(pool_key: str, balance_manager_key: str, client_order_id: str, price: float, quantity: float, is_bid: bool, expiration: int | float | NoneType = None, order_type: int | None = None, self_matching_option: deepbookpy.custom_types.SelfMatchingOptions | None = None, pay_with_deep: bool | None = True)

Bases: object

balance_manager_key: str

client_order_id: str

expiration: int | float | None = None

is_bid: bool

order_type: int | None = None

pay_with_deep: bool | None = True

pool_key: str

price: float

quantity: float

self_matching_option: SelfMatchingOptions | None = None

class deepbookpy.custom_types.PlaceMarketOrderParams(pool_key: str, balance_manager_key: str, client_order_id: str, quantity: float, is_bid: bool, self_matching_option: deepbookpy.custom_types.SelfMatchingOptions | None = None, pay_with_deep: bool | None = True)

Bases: object

balance_manager_key: str

client_order_id: str

is_bid: bool

pay_with_deep: bool | None = True

pool_key: str

quantity: float

self_matching_option: SelfMatchingOptions | None = None

class deepbookpy.custom_types.Pool(address: str, base_coin: str, quote_coin: str)

Bases: object

address: str

base_coin: str

quote_coin: str

class deepbookpy.custom_types.ProposalParams(pool_key: str, balance_manager_key: str, taker_fee: float, maker_fee: float, stake_required: int)

Bases: object

balance_manager_key: str

maker_fee: float

pool_key: str

stake_required: int

taker_fee: float

class deepbookpy.custom_types.SelfMatchingOptions(value)

Bases: Enum

An enumeration.

CANCEL_MAKER = 2

CANCEL_TAKER = 1

SELF_MATCHING_ALLOWED = 0

class deepbookpy.custom_types.SwapParams(pool_key: str, amount: float, deep_amount: float, min_out: float, deep_coin: ForwardRef('TransactionObjectArgument') | None = None, base_coin: ForwardRef('TransactionObjectArgument') | None = None, quote_coin: ForwardRef('TransactionObjectArgument') | None = None)

Bases: object

amount: float

base_coin: TransactionObjectArgument | None = None

deep_amount: float

deep_coin: TransactionObjectArgument | None = None

min_out: float

pool_key: str

quote_coin: TransactionObjectArgument | None = None