# squarelink
> Squarelink's Web3 library
Latest version **1.1.4** (published 2019-10-24) · MIT license · 0 weekly downloads
## Install
```sh
npm install squarelink
pnpm add squarelink
yarn add squarelink
bun add squarelink
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: esm support; no vulnerabilities.
Warnings: low downloads; no types.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.4 |
| Published | 2019-10-24 |
| First published | 2018-06-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 562.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Alexander Patin |
| Maintainers | thealexpatin |
| Keywords | web3, web3.js, ethereum, squarelink, blockchain, dapp, dapps, cryptocurrency |
## Links
- npm: https://www.npmjs.com/package/squarelink
- Repository: https://github.com/Squarelink-Inc/Squarelink-Web3
- Homepage: https://docs.squarelink.com
- Issues: https://github.com/Squarelink-Inc/Squarelink-Web3/issues
- npm.io page: https://npm.io/package/squarelink
## Dependencies (2)
- [bignumber.js](https://npm.io/package/bignumber.js.md) ^9.0.0
- [squarelink-provider-engine](https://npm.io/package/squarelink-provider-engine.md) ^15.0.5
## Alternatives
- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads
## Recent versions
- 1.1.4 (latest) — 2019-10-24
- 1.1.3 — 2019-10-19
- 1.1.2 — 2019-10-02
- 1.1.1 — 2019-10-02
- 1.0.10 — 2019-09-15
- 1.0.9 — 2019-09-08
- 1.0.8 — 2019-09-07
- 1.0.7 — 2019-09-04
- 1.0.6 — 2019-09-03
- 1.0.5 — 2019-09-03
- 1.0.4 — 2019-08-28
- 1.0.3 — 2019-08-28
- 1.0.2 — 2019-08-28
- 1.0.1 — 2019-08-28
- 0.5.3 — 2019-08-22
- … 34 more at https://npm.io/package/squarelink/versions
## README
# Squarelink Web3 SDK
[](https://squarelink.com)
[](https://npmjs.org/package/squarelink)
[](https://t.me/squarelink)
[](https://github.com/Squarelink-Inc/Squarelink-Web3/blob/master/LICENSE.txt)
This is the Squarelink Web3 SDK which enables Squarelink enhancements to standard Web3 JSON RPC requests.
Check out the **[Squarelink Documentation](https://docs.squarelink.com)** for more information, quick-start guides, etc.
## Installation
### Node
```bash
$ npm install squarelink
```
### CDN
```html
```
## Usage
First, register your application at **[dev.squarelink.com](https://dev.squarelink.com)** to obtain your `CLIENT ID`
```javascript
import Web3 from 'web3'
import Squarelink from 'squarelink'
const sqlk = new Squarelink('')
// Use callback or Promise
sqlk.getProvider(provider => {
const web3 = new Web3(provider)
// Use the web3 library as you would normally!
web3.currentProvider.enable()
})
```
### Configuration
`const sqlk = new Squarelink(clientId [, network][, opts])`
`Squarelink`-`Object` - Initializes a Squarelink Web3 Provider for you
- `clientId`-`String` - The Client ID provided to you when you register your DApp in the **[Squarelink Developer Console](https://dev.squarelink.com)**
- `network`-`String|Object` - Configures the RPC node you're connecting to. See **[a list of our available networks](https://docs.squarelink.com/#available-networks)**. Defaults to 'mainnet'.
- `opts` - `Object` - Pass additional options to the Squarelink SDK.
### Examples
```javascript
// connect to the Ropsten network
new Squarelink('', 'ropsten')
```
```javascript
// connect to a custom private network
new Squarelink('', {
url: 'https://localhost:8545',
chainId: 420
})
```
### Options (`opts`)
- `scope` - `Array` - Request additional scopes to use custom Squarelink functions.
- `useSync` - `Boolean` - See *getProviderSync* below for usage (default = false).
#### Available Scopes:
- `user` - Equivalent to all scopes below
- `user:name` - Access to read user's name
- `user:email` - Access to user's email address
- `user:security` - Access to read user's security settings
### Detecting Squarelink
```
web3.currentProvider.isSquarelink
```
### Additional Functions
- *Squarelink*.**getName()** - requires the `user` or `user:name` scope
- *Squarelink*.**getEmail()** - requires the `user` or `user:email` scope
- *Squarelink*.**getSecuritySettings()** - requires the `user` or `user:security` scope
### Initializing Squarelink Synchronously
The `getProvider` function fetches a list of our supported networks and their RPC endpoints from our API. This allows us to remotely switch RPC providers to ensure 100% uptime and remove faulty/compromised endpoints.
If you are unable to support callbacks/promises, you can use `getProviderSync` which uses hard-coded RPC endpoints. **NOTE**: *we cannot guarantee 100% uptime with this method.*
```javascript
const sqlk = new Squarelink('', 'mainnet', { useSync: true })
const web3 = new Web(sqlk.getProviderSync())
```
## Documentation
**[https://docs.squarelink.com](https://docs.squarelink.com)**
## License
MIT
---
_Source: https://npm.io/package/squarelink · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._