@radixdlt/rola
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

License

ROLA (Radix Off-Ledger Authentication)

ROLA is a method of authenticating something claimed by the user connected to your dApp with the Radix Wallet. It uses the capabilities of the Radix Network to make this possible in a way that is decentralized and flexible for the user.

ROLA is intended for use in the server backend portion of a Full Stack dApp. It runs "off-ledger" alongside backend business and user management logic, providing reliable authentication of claims of user control using "on-ledger" data from the Radix Network.

Resources

What is ROLA

Getting started

npm install @radixdlt/rola isomorphic-fetch

How to use

import 'isomorphic-fetch'
import { Rola, NetworkId, SignedChallenge } from '@radixdlt/rola'

const { verifySignedChallenge } = Rola({
  networkId: NetworkId.RCNetV3,
  applicationName: 'Gumball Club',
  dAppDefinitionAddress:
    'account_tdx_e_128uml7z6mqqqtm035t83alawc3jkvap9sxavecs35ud3ct20jxxuhl',
  expectedOrigin:
    'https://radix-dapp-toolkit-dev.rdx-works-main.extratools.works',
})

// signed challenge response returned from wallet
const signedChallenge = {
  challenge: 'b519902dd21c9669b81bb5023687879d178e5c4991ba1d0ee9e131cee365bafa',
  proof: {
    publicKey:
      '1456b4da4ee62da249459f2180b83e5ebd5db8bad2ed1d8f35f51e7ec2cc98ce',
    signature:
      '8335e38096b3f0ac943c04e4c0b286af8cb711cb5f603a023d1d387fdd0cfae1a0255bcdb5d75cd43690413798959bd4c05af9b86f30d6ff74561bb9c8869202',
    curve: 'curve25519',
  },
  address:
    'identity_tdx_e_122mta8gr4tnjwywlxp5pdt03wfrd68pckne5z3cg2ce4kl3lw48ucy',
  type: 'persona',
}

const result = await verifySignedChallenge(signedChallenge)

// handle error response
if (result.isErr()) throw result.error

Examples

Full stack example

License

The ROLA code and examples is released under Apache 2.0 license. Binaries are licensed under the Radix Software EULA

Package Sidebar

Install

npm i @radixdlt/rola

Weekly Downloads

304

Version

1.1.0

License

SEE LICENSE IN RADIX-SOFTWARE-EULA

Unpacked Size

14.1 MB

Total Files

16

Last publish

Collaborators

  • javier-rdx
  • rdxrussell
  • bryanrdxworks
  • radixpublishing-owner
  • alex-rdx
  • aleworm