mirror of
https://github.com/orionprotocol/sdk.git
synced 2026-03-13 21:52:36 +03:00
fix: semantics
This commit is contained in:
12
README.md
12
README.md
@@ -48,12 +48,12 @@ Orion’s SDK is free to use and does not require an API key or registration. Re
|
||||
- [Get tradable pairs](#get-tradable-pairs)
|
||||
- [Get fee assets](#get-fee-assets)
|
||||
- [Get swap info](#get-swap-info-1)
|
||||
- [Place order in Orion Aggregator](#place-order-in-orion-aggregator)
|
||||
- [Orion Aggregator WebSocket](#orion-aggregator-websocket)
|
||||
- [Place order in Aggregator](#place-order-in-aggregator)
|
||||
- [Aggregator WebSocket](#aggregator-websocket)
|
||||
- [Swap Info](#swap-info)
|
||||
- [Balances and order history stream](#balances-and-order-history-stream)
|
||||
- [Orderbook stream](#orderbook-stream)
|
||||
- [Orion Aggregator WS Stream Unsubscribing](#orion-aggregator-ws-stream-unsubscribing)
|
||||
- [Aggregator WS Stream Unsubscribing](#aggregator-ws-stream-unsubscribing)
|
||||
- [Price Feed Websocket Stream](#price-feed-websocket-stream)
|
||||
- [Data fetching](#data-fetching)
|
||||
- [Using contracts](#using-contracts)
|
||||
@@ -427,7 +427,7 @@ Swap info response example:
|
||||
}
|
||||
```
|
||||
|
||||
### Place order in Orion Aggregator
|
||||
### Place order in Aggregator
|
||||
|
||||
```ts
|
||||
import { simpleFetch, crypt } from "@orionprotocol/sdk";
|
||||
@@ -477,7 +477,7 @@ const { orderId } = await simpleFetch(unit.aggregator.placeOrder)(
|
||||
);
|
||||
```
|
||||
|
||||
### Orion Aggregator WebSocket
|
||||
### Aggregator WebSocket
|
||||
|
||||
Available subscriptions:
|
||||
|
||||
@@ -571,7 +571,7 @@ unit.aggregator.ws.subscribe("aobus", {
|
||||
unit.aggregator.ws.unsubscribe("ORN-USDT");
|
||||
```
|
||||
|
||||
### Orion Aggregator WS Stream Unsubscribing
|
||||
### Aggregator WS Stream Unsubscribing
|
||||
|
||||
```ts
|
||||
// Asset pairs config updates unsubscribe
|
||||
|
||||
@@ -129,5 +129,5 @@ If you don't want to deposit funds to the exchange contract, you can set "poolOn
|
||||
SDK have multiple ways to make swap:
|
||||
|
||||
1. Call `unit.exchange.swapMarket`. This is the simplest way to swap. All inclusive method. [See description](../README.md#make-swap-market)
|
||||
2. Call `unit.aggregator.placeOrder`. This is method to place order to **aggregator**. More verbose. [See description](../README.md#place-order-in-orion-aggregator)
|
||||
2. Call `unit.aggregator.placeOrder`. This is method to place order to **aggregator**. More verbose. [See description](../README.md#place-order-in-aggregator)
|
||||
3. Call method `swapThroughOrionPool` on exchange contract. This is method to swap tokens through **pool**. [See code example](../src/Unit/Exchange/swapMarket.ts)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import Orion from '../Orion/index.js';
|
||||
|
||||
describe('Orion Aggregator', () => {
|
||||
describe('Aggregator', () => {
|
||||
test('Handle error aus', async () => {
|
||||
const orion = new Orion('testing');
|
||||
const bscUnit = orion.getUnit('bsc')
|
||||
|
||||
Reference in New Issue
Block a user