@proton/browser-transport

Proton Browser Transport

A transport library for usage of Proton Link within a web browser environment.

Basic usage

A transport is required for Proton Link to communicate with clients. In most examples we use the browser transport with no configuration, like so:

const transport = new ProtonLinkBrowserTransport()
const link = new ProtonLink({transport})

Parameters can be passed to the transport during construction as an object, allowing for the following optional changes:

const transport = new ProtonLinkBrowserTransport({
    /** CSS class prefix, defaults to `@proton/link` */
    classPrefix: 'my-css-prefix',
    /** Whether to inject CSS styles in the page header, defaults to true. */
    injectStyles: true,
    /** Whether to display request success and error messages, defaults to true */
    requestStatus: false,
    /** Local storage prefix, defaults to `@proton/link`. */
    storagePrefix: 'my-localstorage-prefix',
    /** Requesting account of the dapp (optional) */
    requestAccount: 'taskly',
    /** Wallet name e.g. proton, anchor, etc */
    walletType: 'proton'
})
const link = new ProtonLink({transport})

Developing

You need Make, node.js and yarn installed.

Clone the repository and run make to checkout all dependencies and build the project. See the Makefile for other useful targets. Before submitting a pull request make sure to run make lint.

Implementation Details

Proton Web SDK is a cross-device authentication and signing protocol built on top of ESR (EOSIO Signing Requests / EEP-7).

More information in the Proton Web SDK

License

MIT

Made with ☕️ & ❤️ by Greymass and Proton.