docs: 更新 lighter-python-main 文档,添加示例代码和 API 说明,重构部分内容以提高可读性

This commit is contained in:
discountry
2025-09-30 18:35:14 +08:00
parent d6533733c9
commit e83bdfccf9
337 changed files with 50410 additions and 0 deletions
@@ -0,0 +1,294 @@
docs/Account.md
docs/AccountApi.md
docs/AccountApiKeys.md
docs/AccountLimits.md
docs/AccountMarginStats.md
docs/AccountMarketStats.md
docs/AccountMetadata.md
docs/AccountMetadatas.md
docs/AccountPnL.md
docs/AccountPosition.md
docs/AccountStats.md
docs/AccountTradeStats.md
docs/Announcement.md
docs/AnnouncementApi.md
docs/Announcements.md
docs/ApiKey.md
docs/Block.md
docs/BlockApi.md
docs/Blocks.md
docs/BridgeApi.md
docs/BridgeSupportedNetwork.md
docs/Candlestick.md
docs/CandlestickApi.md
docs/Candlesticks.md
docs/ContractAddress.md
docs/CurrentHeight.md
docs/Cursor.md
docs/DailyReturn.md
docs/DepositHistory.md
docs/DepositHistoryItem.md
docs/DetailedAccount.md
docs/DetailedAccounts.md
docs/DetailedCandlestick.md
docs/EnrichedTx.md
docs/ExchangeStats.md
docs/ExportData.md
docs/Funding.md
docs/FundingApi.md
docs/FundingRate.md
docs/FundingRates.md
docs/Fundings.md
docs/InfoApi.md
docs/L1Metadata.md
docs/L1ProviderInfo.md
docs/LiqTrade.md
docs/Liquidation.md
docs/LiquidationInfo.md
docs/LiquidationInfos.md
docs/MarketInfo.md
docs/NextNonce.md
docs/NotificationApi.md
docs/Order.md
docs/OrderApi.md
docs/OrderBook.md
docs/OrderBookDepth.md
docs/OrderBookDetail.md
docs/OrderBookDetails.md
docs/OrderBookOrders.md
docs/OrderBookStats.md
docs/OrderBooks.md
docs/Orders.md
docs/PnLEntry.md
docs/PositionFunding.md
docs/PositionFundings.md
docs/PriceLevel.md
docs/PublicPool.md
docs/PublicPoolInfo.md
docs/PublicPoolMetadata.md
docs/PublicPoolShare.md
docs/PublicPools.md
docs/ReferralApi.md
docs/ReferralPointEntry.md
docs/ReferralPoints.md
docs/ReqExportData.md
docs/ReqGetAccount.md
docs/ReqGetAccountActiveOrders.md
docs/ReqGetAccountApiKeys.md
docs/ReqGetAccountByL1Address.md
docs/ReqGetAccountInactiveOrders.md
docs/ReqGetAccountLimits.md
docs/ReqGetAccountMetadata.md
docs/ReqGetAccountPnL.md
docs/ReqGetAccountTxs.md
docs/ReqGetBlock.md
docs/ReqGetBlockTxs.md
docs/ReqGetByAccount.md
docs/ReqGetCandlesticks.md
docs/ReqGetDepositHistory.md
docs/ReqGetFastWithdrawInfo.md
docs/ReqGetFundings.md
docs/ReqGetL1Metadata.md
docs/ReqGetL1Tx.md
docs/ReqGetLatestDeposit.md
docs/ReqGetLiquidationInfos.md
docs/ReqGetNextNonce.md
docs/ReqGetOrderBookDetails.md
docs/ReqGetOrderBookOrders.md
docs/ReqGetOrderBooks.md
docs/ReqGetPositionFunding.md
docs/ReqGetPublicPools.md
docs/ReqGetPublicPoolsMetadata.md
docs/ReqGetRangeWithCursor.md
docs/ReqGetRangeWithIndex.md
docs/ReqGetRangeWithIndexSortable.md
docs/ReqGetRecentTrades.md
docs/ReqGetReferralPoints.md
docs/ReqGetTrades.md
docs/ReqGetTransferFeeInfo.md
docs/ReqGetTransferHistory.md
docs/ReqGetTx.md
docs/ReqGetWithdrawHistory.md
docs/RespChangeAccountTier.md
docs/RespGetFastBridgeInfo.md
docs/RespPublicPoolsMetadata.md
docs/RespSendTx.md
docs/RespSendTxBatch.md
docs/RespWithdrawalDelay.md
docs/ResultCode.md
docs/RiskInfo.md
docs/RiskParameters.md
docs/RootApi.md
docs/SharePrice.md
docs/SimpleOrder.md
docs/Status.md
docs/SubAccounts.md
docs/Ticker.md
docs/Trade.md
docs/Trades.md
docs/TransactionApi.md
docs/TransferFeeInfo.md
docs/TransferHistory.md
docs/TransferHistoryItem.md
docs/Tx.md
docs/TxHash.md
docs/TxHashes.md
docs/Txs.md
docs/ValidatorInfo.md
docs/WithdrawHistory.md
docs/WithdrawHistoryItem.md
docs/ZkLighterInfo.md
git_push.sh
lighter/__init__.py
lighter/api/__init__.py
lighter/api/account_api.py
lighter/api/announcement_api.py
lighter/api/block_api.py
lighter/api/bridge_api.py
lighter/api/candlestick_api.py
lighter/api/funding_api.py
lighter/api/info_api.py
lighter/api/notification_api.py
lighter/api/order_api.py
lighter/api/referral_api.py
lighter/api/root_api.py
lighter/api/transaction_api.py
lighter/api_client.py
lighter/api_response.py
lighter/configuration.py
lighter/exceptions.py
lighter/models/__init__.py
lighter/models/account.py
lighter/models/account_api_keys.py
lighter/models/account_limits.py
lighter/models/account_margin_stats.py
lighter/models/account_market_stats.py
lighter/models/account_metadata.py
lighter/models/account_metadatas.py
lighter/models/account_pn_l.py
lighter/models/account_position.py
lighter/models/account_stats.py
lighter/models/account_trade_stats.py
lighter/models/announcement.py
lighter/models/announcements.py
lighter/models/api_key.py
lighter/models/block.py
lighter/models/blocks.py
lighter/models/bridge_supported_network.py
lighter/models/candlestick.py
lighter/models/candlesticks.py
lighter/models/contract_address.py
lighter/models/current_height.py
lighter/models/cursor.py
lighter/models/daily_return.py
lighter/models/deposit_history.py
lighter/models/deposit_history_item.py
lighter/models/detailed_account.py
lighter/models/detailed_accounts.py
lighter/models/detailed_candlestick.py
lighter/models/enriched_tx.py
lighter/models/exchange_stats.py
lighter/models/export_data.py
lighter/models/funding.py
lighter/models/funding_rate.py
lighter/models/funding_rates.py
lighter/models/fundings.py
lighter/models/l1_metadata.py
lighter/models/l1_provider_info.py
lighter/models/liq_trade.py
lighter/models/liquidation.py
lighter/models/liquidation_info.py
lighter/models/liquidation_infos.py
lighter/models/market_info.py
lighter/models/next_nonce.py
lighter/models/order.py
lighter/models/order_book.py
lighter/models/order_book_depth.py
lighter/models/order_book_detail.py
lighter/models/order_book_details.py
lighter/models/order_book_orders.py
lighter/models/order_book_stats.py
lighter/models/order_books.py
lighter/models/orders.py
lighter/models/pn_l_entry.py
lighter/models/position_funding.py
lighter/models/position_fundings.py
lighter/models/price_level.py
lighter/models/public_pool.py
lighter/models/public_pool_info.py
lighter/models/public_pool_metadata.py
lighter/models/public_pool_share.py
lighter/models/public_pools.py
lighter/models/referral_point_entry.py
lighter/models/referral_points.py
lighter/models/req_export_data.py
lighter/models/req_get_account.py
lighter/models/req_get_account_active_orders.py
lighter/models/req_get_account_api_keys.py
lighter/models/req_get_account_by_l1_address.py
lighter/models/req_get_account_inactive_orders.py
lighter/models/req_get_account_limits.py
lighter/models/req_get_account_metadata.py
lighter/models/req_get_account_pn_l.py
lighter/models/req_get_account_txs.py
lighter/models/req_get_block.py
lighter/models/req_get_block_txs.py
lighter/models/req_get_by_account.py
lighter/models/req_get_candlesticks.py
lighter/models/req_get_deposit_history.py
lighter/models/req_get_fast_withdraw_info.py
lighter/models/req_get_fundings.py
lighter/models/req_get_l1_metadata.py
lighter/models/req_get_l1_tx.py
lighter/models/req_get_latest_deposit.py
lighter/models/req_get_liquidation_infos.py
lighter/models/req_get_next_nonce.py
lighter/models/req_get_order_book_details.py
lighter/models/req_get_order_book_orders.py
lighter/models/req_get_order_books.py
lighter/models/req_get_position_funding.py
lighter/models/req_get_public_pools.py
lighter/models/req_get_public_pools_metadata.py
lighter/models/req_get_range_with_cursor.py
lighter/models/req_get_range_with_index.py
lighter/models/req_get_range_with_index_sortable.py
lighter/models/req_get_recent_trades.py
lighter/models/req_get_referral_points.py
lighter/models/req_get_trades.py
lighter/models/req_get_transfer_fee_info.py
lighter/models/req_get_transfer_history.py
lighter/models/req_get_tx.py
lighter/models/req_get_withdraw_history.py
lighter/models/resp_change_account_tier.py
lighter/models/resp_get_fast_bridge_info.py
lighter/models/resp_public_pools_metadata.py
lighter/models/resp_send_tx.py
lighter/models/resp_send_tx_batch.py
lighter/models/resp_withdrawal_delay.py
lighter/models/result_code.py
lighter/models/risk_info.py
lighter/models/risk_parameters.py
lighter/models/share_price.py
lighter/models/simple_order.py
lighter/models/status.py
lighter/models/sub_accounts.py
lighter/models/ticker.py
lighter/models/trade.py
lighter/models/trades.py
lighter/models/transfer_fee_info.py
lighter/models/transfer_history.py
lighter/models/transfer_history_item.py
lighter/models/tx.py
lighter/models/tx_hash.py
lighter/models/tx_hashes.py
lighter/models/txs.py
lighter/models/validator_info.py
lighter/models/withdraw_history.py
lighter/models/withdraw_history_item.py
lighter/models/zk_lighter_info.py
lighter/py.typed
lighter/rest.py
setup.cfg
test-requirements.txt
test/__init__.py
tox.ini
@@ -0,0 +1 @@
7.7.0