@quantabit/order-sdk
v1.0.2
Published
QuantaBit Order SDK - Order creation, management, and status flow
Maintainers
Readme
@quantabit/order-sdk
QuantaBit Order SDK - Order creation, management, and status flow
📦 Installation
npm install @quantabit/order-sdk
# or
yarn add @quantabit/order-sdk🚀 Quick Start
1. Setup Provider
import { OrderProvider } from "@quantabit/order-sdk";
import "@quantabit/order-sdk/styles.css";
function App() {
return (
<OrderProvider
apiUrl="https://api.example.com/v1"
token="your-auth-token"
language="en"
onOrderPay={(result) => console.log("Payment:", result)}
>
<YourComponent />
</OrderProvider>
);
}2. Using Components
import { OrderCard, OrderList } from '@quantabit/order-sdk';
// Order card
<OrderCard
order={orderData}
onPay={(order) => handlePay(order)}
onDetail={(order) => navigateToDetail(order.id)}
/>
// Order list
<OrderList
showFilter
onPay={(order) => handlePay(order)}
onDetail={(order) => navigateToDetail(order.id)}
/>3. Using Hooks
import { useOrder } from "@quantabit/order-sdk";
function MyComponent() {
const {
orders, // Order list
currentOrder, // Current order details
stats, // Order statistics
loading,
createOrder, // Create order
loadOrders, // Load order list
cancelOrder, // Cancel order
payOrder, // Pay order
confirmReceive, // Confirm receipt
} = useOrder();
return <div>...</div>;
}📚 Components
| Component | Description |
| ----------- | -------------------------------------------------- |
| OrderCard | Order card (product list, amount, status, actions) |
| OrderList | Order list (status filtering, pagination) |
📖 Type Definitions
import { OrderStatus, OrderType, PaymentMethod } from "@quantabit/order-sdk";
// Order status
OrderStatus.PENDING; // Pending payment
OrderStatus.PAID; // Paid
OrderStatus.PROCESSING; // Processing
OrderStatus.SHIPPED; // Shipped
OrderStatus.COMPLETED; // Completed
OrderStatus.CANCELLED; // Cancelled
// Order types
OrderType.GOODS; // Physical goods
OrderType.SERVICE; // Service
OrderType.VIRTUAL; // Virtual goods
OrderType.SUBSCRIPTION; // Subscription🧮 Utility Functions
import {
canPay,
canCancel,
formatPrice,
getPaymentRemaining,
} from "@quantabit/order-sdk";
// Check if order can be paid/cancelled
const payable = canPay(order);
const cancelable = canCancel(order);
// Format price
formatPrice(99.9, "CNY"); // ¥99.90
// Calculate payment remaining time
const remaining = getPaymentRemaining(order.expire_at);📄 License
MIT License
🌐 Brand & Links
- Official Mainnet: QuantaBit Chain
- Developer Platform: Developer Platform
- Open Platform: Open Platform
- Payment Platform: Pay Platform
- Feedback: Feedback
