https://github.com/EOSIO/ual-scatter

authenticator meant to be used with Scatter and Universal Authenticator Library
https://github.com/EOSIO/ual-scatter

Last synced: about 1 month ago
JSON representation

authenticator meant to be used with Scatter and Universal Authenticator Library

• Host: GitHub
• URL: https://github.com/EOSIO/ual-scatter
• Owner: EOSIO
• License: mit
• Created: 2019-03-12T16:18:11.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-07-18T20:38:09.000Z (over 1 year ago)
• Last Synced: 2024-04-02T17:44:26.312Z (8 months ago)
• Language: TypeScript
• Homepage:
• Size: 1.01 MB
• Stars: 14
• Watchers: 29
• Forks: 29
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-eosio - EOSIO/ual-scatter - Authenticator meant to be used with Scatter and Universal Authenticator Library. (Developers / Libraries and Frameworks)

README

        
# UAL for Scatter Authenticator

This authenticator is meant to be used with [Scatter](https://get-scatter.com/) and [Universal Authenticator Library](https://github.com/EOSIO/universal-authenticator-library). When used in combination with them, it gives developers the ability to request transaction signatures through Scatter using the common UAL API.

![EOSIO Labs](https://img.shields.io/badge/EOSIO-Labs-5cb3ff.svg)

# About EOSIO Labs

EOSIO Labs repositories are experimental.  Developers in the community are encouraged to use EOSIO Labs repositories as the basis for code and concepts to incorporate into their applications. Community members are also welcome to contribute and further develop these repositories. Since these repositories are not supported by Block.one, we may not provide responses to issue reports, pull requests, updates to functionality, or other requests from the community, and we encourage the community to take responsibility for these.

## Supported Environments

- The Scatter Authenticator only supports Desktop Browser Environments

## Getting Started

`yarn add ual-scatter`

#### Dependencies

You must use one of the UAL renderers below.

React - `ual-reactjs-renderer`

PlainJS - `ual-plainjs-renderer`

#### Basic Usage with React

```javascript

import { Scatter } from 'ual-scatter'

import { UALProvider, withUAL } from 'ual-reactjs-renderer'

const exampleNet = {

  chainId: '',

  rpcEndpoints: [{

    protocol: '',

    host: '',

    port: '',

  }]

}

const App = (props) => 
{JSON.stringify(props.ual)}

const AppWithUAL = withUAL(App)


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

  

```

## Contributing

[Contributing Guide](https://github.com/EOSIO/ual-scatter/blob/develop/CONTRIBUTING.md)

[Code of Conduct](https://github.com/EOSIO/ual-scatter/blob/develop/CONTRIBUTING.md#conduct)

## License

[MIT](https://github.com/EOSIO/ual-scatter/blob/develop/LICENSE)

## Important

See [LICENSE](./LICENSE) for copyright and license terms.

All repositories and other materials are provided subject to the terms of this [IMPORTANT](./IMPORTANT.md) notice and you must familiarize yourself with its terms.  The notice contains important information, limitations and restrictions relating to our software, publications, trademarks, third-party resources, and forward-looking statements.  By accessing any of our repositories and other materials, you accept and agree to the terms of the notice.