Mirror/orionprotocol-sdk
1
0
Fork 0
mirror of https://github.com/orionprotocol/sdk.git synced 2026-03-25 23:27:41 +03:00
Code Issues Packages Projects Releases Wiki Activity

Better docs

Browse Source
This commit is contained in:
Aleksandr Kraiz
2023-02-08 01:01:30 +04:00
parent 68c535103e
commit 1f19a50839
3 changed files with 34 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
ADVANCED.md
View File

@@ -23,4 +23,25 @@ const orion = new Orion({
},
},
});
const orionUnit = orion.getUnit("bsc");
// OR
const orionUnit = orion.getUnit(SupportedChainId.BSC);
// OR
const orionUnit = new OrionUnit({
chainId: SupportedChainId.BSC,
nodeJsonRpc: "https://bsc-dataseed.binance.org/",
services: {
orionBlockchain: {
http: "https://orion-bsc-api.orionprotocol.io",
},
orionAggregator: {
http: "https://orion-bsc-api.orionprotocol.io/backend",
ws: "https://orion-bsc-api.orionprotocol.io/v1",
},
priceFeed: {
api: "https://orion-bsc-api.orionprotocol.io/price-feed",
},
},
});
```

2
package.json
View File

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

15
src/Orion/index.ts
View File

@@ -108,9 +108,18 @@ export default class Orion {
return Object.entries(this.units).map(([, unit]) => unit);
}
getUnit(networkCode: string) {
const unit = this.unitsArray.find((unit) => unit.networkCode === networkCode);
if (!unit) throw new Error(`Invalid network code: ${networkCode}. Available network codes: ${this.unitsArray.map((unit) => unit.networkCode).join(', ')}`);
getUnit(chainId: SupportedChainId): OrionUnit;
getUnit(networkCode: string): OrionUnit;
getUnit(networkCodeOrChainId: string): OrionUnit {
let unit: OrionUnit | undefined;
if (isValidChainId(networkCodeOrChainId)) {
unit = this.units[networkCodeOrChainId];
} else {
unit = this.unitsArray.find((unit) => unit.networkCode === networkCodeOrChainId);
}
if (!unit) throw new Error(`Invalid network code: ${networkCodeOrChainId}. Available network codes: ${this.unitsArray.map((unit) => unit.networkCode).join(', ')}`);
return unit;
}