-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit ce50595
Showing
76 changed files
with
10,312 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
node_modules/ | ||
obsolete/ | ||
|
||
env-esm.js | ||
env-umd.js | ||
env.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2021 Richard Moore | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
Ancillary Package: OKExChain | ||
============================ | ||
|
||
[![npm version](https://badge.fury.io/js/%40ethers-ancillary%2Fokexchain.svg)](https://www.npmjs.com/package/@ethers-ancillary/okexchain) | ||
|
||
**Experimental:** This packages is still in the early stages | ||
of the ancillary package template and the library has not | ||
been thoroughly tested. | ||
|
||
An ancillary package for OKExChain. | ||
|
||
|
||
Installing and Importing | ||
------------------------ | ||
|
||
**Node** | ||
|
||
``` | ||
/home/ricmoo> npm install @ethers-ancillary/okexchain | ||
``` | ||
|
||
```javascript | ||
// JavaScript | ||
const { OkexchainProvider } = require("@ethers-ancillary/okexchain"); | ||
|
||
// TypeScript | ||
import { OkexchainProvider } from "@ethers-ancillary/okexchain"; | ||
``` | ||
|
||
**Browser** | ||
|
||
Include the ESM module (ethers-okexchain-provider.esm.js) in the same folder as the | ||
core library (i.e. ethers.esm.js) and import using: | ||
|
||
```html | ||
<script type="module"> | ||
import { OkexchainProvider } from "./okexchain.esm.js"; | ||
</script> | ||
``` | ||
|
||
|
||
Application Programming Interface (API) | ||
--------------------------------------- | ||
|
||
**getDefaultProvider(networkish?)** | ||
|
||
Create a new default provider connected to *networkish*, which may | ||
be a chain name (i.e. `"exchain"` or `"exchain-testnet`") or chain ID. | ||
|
||
This will create a FallbackProvider, backed by all popular Third-Party | ||
OKExChain services (currently only [None](https://TODO)). | ||
|
||
|
||
**OKExChainProvider** | ||
|
||
The API for this provider is identical to the [EtherscanProvider](https://docs.ethers.io/v5/api/providers/api-providers/#EtherscanProvider), | ||
except uses [bscscan.com](https://bscscan.com) (which is owned and operated by | ||
the same company as Etherscan and has the same underlying API) as its source for | ||
the BSC (Binance Smart Chain) network. | ||
|
||
See [EtherscanProvider](https://docs.ethers.io/v5/api/providers/api-providers/#EtherscanProvider). | ||
|
||
|
||
License | ||
------- | ||
|
||
MIT License. |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.