@protonprotocol/proton-link NPM

Proton Link !(https://img.shields.io/npm/v/@protonprotocol/https://www.npmjs.com/package/@protonprotocol/proton-link.svg?style=flat-square

Persistent, fast and secure signature provider for Proton chain built on top of EOSIO Signing Requests (EEP-7). This was forked from the Anchor Link module, much of the documentation from Anchor Link still applies.

Key features:

Persistent sessions
Cross device signing
End to end encryption
Open standard

Resources:

Installation

The proton-link package is distributed as a module on npm

Browser using a bundler (recommended)

Install Proton Link and a transport:

yarn add proton-link proton-browser-transport
# or
npm install --save proton-link proton-browser-transport

Import them into your project:

import ProtonLink from 'proton-link'
import ProtonLinkBrowserTransport from 'proton-browser-transport'

Using node.js

yarn add @protonprotocol/proton-link @protonprotocol/proton-browser-transport
# or
npm install --save @protonprotocol/proton-link @protonprotocol/proton-browser-transport

Import them into your project:

const ProtonLink = require('proton-link')
const ProtonLinkBrowserTransport = require('proton-browser-transport')

Basic usage

First you need to instantiate your transport and the link.

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

For more customization, please see Proton Browser Transport

Now you're ready to create signing requests for Proton main-net.

const action = {
    account: 'xtokens',
    name: 'transfer',
    authorization: [{
        actor: '............1', // ............1 will be resolved to the signing accounts permission
        permission: '............2' // ............2 will be resolved to the signing accounts authority
    }],
    data: {
        from: '............1',
        to: targetAccount,
        quantity: '0.01000000 XUSDT',
        memo: 'Taskly'
    }
}
link.transact({action}).then((result) => {
    console.log(`Transaction broadcast! Transaction id: ${ result.processed.id }`)
})

See the Link.transact API docs for all options and return values.

To create a persistent login session use Link.login, example:

link.login('mydapp').then(({session}) => {
    session.transact({action}).then((result) => {
        console.log(`Transaction broadcast! Transaction id: ${ result.processed.id }`)
    })
})

You can find more examples in the examples directory in the root of this repository.

Transports

Transports in Anchor Link are responsible for getting signature requests to the users wallet when establishing a session or when using anchor link without logging in.

Available transports:

Package	Description
proton-browser-transport	Browser overlay that generates QR codes or triggers local URI handler if available

See the LinkTransport documentation for details on how to implement custom transports.

Protocol

The Proton Link protocol uses EEP-7 identity requests to establish a channel to compatible wallets using an untrusted HTTP POST to WebSocket forwarder (see buoy node.js and buoy golang).

A session key and unique channel URL is generated by the client which is attached to the identity request and sent to the wallet (see transports). The wallet signs the identity proof and sends it back along with its own channel URL and session key. Subsequent signature requests can now be encrypted to a shared secret derived from the two keys and pushed directly to the wallet channel.

📘 Protocol specification

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.