arisen-ual-peepsid

UAL for dWebID Authenticator

This authenticator is meant to be used with the dWebID Authenticator Apps and the Universal Authenticator Library.

Getting Started

yarn add arisen-ual-dwebid

Dependencies

• All apps must follow the Manifest Specification

• You must use one of the UAL renderers below.

  • React - https://github.com/arisenio/dwebual-reactjs-renderer

  • PlainJS - https://github.com/arisenio/dwebarisen-ual-plainjs-renderer

Basic Usage with React

import { ARISENAuth } from 'arisen-ual-dwebid'
import { UALProvider, withUAL } from '@dwebual/reactjs-renderer'

const exampleNet = {
  chainId: '',
  rpcEndpoints: [{
    protocol: '',
    host: '',
    port: '',
  }]
}

const App = (props) => <div>{JSON.stringify(props.ual)}</div>
const AppWithUAL = withUAL(App)

const arisenAuth = new ARISENAuth([exampleNet], { appName: 'Example App' })

<UALProvider chains={[exampleNet]} authenticators={[arisenAuth]}>
  <AppWithUAL />
</UALProvider>

Supported Environments

The UAL dWebID Authenticator is currently supported on the following environments and their required options are listed below:

• Chrome Desktop Browser - dWebID Chrome Extension Authenticator App
  • Required option: appName
  • Optional option: securityExclusions

  const securityExclusions = {
    addAssertToTransactions: false
  }
  const arisenAuth = new ARISENAuth([exampleNet], { appName: 'Example App', securityExclusions })

• iOS - dWebID iOS Authenticator App
  • Required options: appName, protocol
  • Optional option: securityExclusions

  const securityExclusions = {
    addAssertToTransactions: false
  }
  const arisenAuth = new ARISENAuth([exampleNet], { appName: 'Example App', protocol: 'arisen', securityExclusions })

License

MIT