Docs improvements

This commit is contained in:
Aleksandr Kraiz
2023-02-08 13:34:36 +04:00
parent 75e674a5bf
commit 2ac5b58f43
3 changed files with 18 additions and 1 deletions

View File

@@ -24,6 +24,17 @@ const orion = new Orion({
},
});
// Also you can set some config as default and override it for some params
const orion = new Orion("testing", {
analyticsAPI: "https://asdasd.orionprotocol.io",
networks: {
[SupportedChainId.BSC_TESTNET]: {
nodeJsonRpc: "https://data-seed-prebsc-1-s1.binance.org:8545/",
},
},
});
// Orion unit init
const orionUnit = orion.getUnit("bsc");
// OR
const orionUnit = orion.getUnit(SupportedChainId.BSC);

View File

@@ -1,6 +1,6 @@
{
"name": "@orionprotocol/sdk",
"version": "0.17.0-rc.5",
"version": "0.17.0-rc.6",
"description": "Orion Protocol SDK",
"main": "./lib/esm/index.js",
"module": "./lib/esm/index.js",

View File

@@ -33,6 +33,12 @@ export default class Orion {
constructor(config: EnvConfig);
// TODO: get tradable assets (aggregated)
// TODO: get tradable pairs (aggregated)
// TODO: bridge
constructor(
envOrConfig: string | EnvConfig,
overrides?: DeepPartial<EnvConfig>