atlas-sdk
v1.0.0
Published
Cross iframe Ethereum provider SDK for Atlas platform
Downloads
2
Maintainers
Readme
Atlas SDK
The Atlas SDK is a JavaScript library providing functionality similar to Metamask for integrating the Atlas Wallet services within web applications.
Installation
Install the Atlas SDK via npm:
npm install atlas-sdk
Usage
Here's a simple example of how to use the Atlas SDK:
import AtlasSDK from 'atlas-sdk';
// Initialize the Atlas SDK to replace the metamask provider
AtlasSDK.initializeAtalasSDK();
Initializes the Atlas SDK. This method attempts to inject the provider object into the page. By now window.ethereum shoud be atlas wallet
Prerequisites
Before using the Atlas SDK, ensure the following conditions are met:
The HTML document must have a doctype of HTML. The current page isn't of prohibited file types, such as XML or PDF. The document element of the page must be HTML. The current page isn't part of the blocked domain list. CSP does not allow the use of 'unsafe-inline'.
FAQ
If you encounter any issues while using the SDK, refer to our FAQ section for additional help.
Contributing
Contributions, issues, and feature requests are welcome! Check out our Contribution Guidelines.
License
The Atlas SDK is released under the MIT License.