npm package: @rubiconstudio/auth
Description: Easy Authentication SDK for web3 powered applications
Latest version: 1.0.3

# Rubicon Auth SDK

Easy Wallet SDK for web3 powered applications


[//]: # (TODO insert here a nice pic)
Building web3 applications can be a complex and challenging task. Fortunately, our Auth SDK simplifies the process by
providing a user-friendly solution for integrating a web3 Login module into your application.

With our SDK, you can implement a passwordless, non-custodial login feature in your dapp with just a few lines of code.
This ensures that your users can securely access your application without having to worry about the safety of their
personal data.

Our Auth SDK also offers the flexibility to build a login infrastructure based on social logins or email. This allows
you to customize the login experience for your users and create a seamless user journey.

## Supported authentication  methods

Currently, we support the following authentication methods:

| Method        | Type              |
|:--------------|:------------------|
| Google        | Oauth             |
| Discord       | Oauth             |
| Twitch        | Oauth             |
| Email         | Passwordless flow |

## Getting started

### Installation

```shell
npm i --save @rubiconstudio/auth
// or
yarn add --save @rubiconstudio/auth
```

### Usage

To quickly have access to the several login methods we support, just import the sdk and initialize it

```typescript
import { SocialWeb3Login as Web3Login } from "@rubiconstudio/auth"

// ... 
const loginSDK = new Web3Login();
await loginSDK.init()

// ...
// You can login with some auth method
const {userInfo, provider, signer} = await loginSDK.connectTo("google")

//...
// When you want to logout
await loginSDK.logout()
```

That's it, now you have a web3 provider available in your app!

For more documentation about what a web3 provider is, checkout
the [ethers Provider documentation](https://docs.ethers.io/v5/api/providers/provider/).

### Advanced usage

Your login infrastructure may need further control about what happens during the login lifecycle.
The [SocialWeb3Login](https://rubiconstudio.github.io/auth/classes/SocialWeb3Login.html) class can be instantiated with
an [options object](https://rubiconstudio.github.io/auth/interfaces/LoginOptions.html)
You can configure several SDK settings, one very useful option is
the [eventSubscriber](https://rubiconstudio.github.io/auth/interfaces/EventSubscriber.html).
Here's an example of SDK initialization with an eventSubscriber option.

```typescript
import {
  SocialWeb3Login as Web3Login,
  EventSubscriber,
  LoginOptions,
  LoginProvider,
} from "@rubiconstudio/auth"


const eventSubscriber: EventSubscriber = {
  async onConnecting() {
    // put here your logic during connection
    console.log("Connecting");
  },
  async onConnected({ userInfo, provider, signer }) {
    // put here your logic for post connection
    console.log("Connected with user info: ", userInfo);
  },
  async onDisconnected() {
    // put here your logic for post disconnection
    console.log("Disconnected");
  },
  async onErrored(error) {
    // put here your logic for handling errors
    console.log("Connection error: ", error);
  },
};

// ... 
const loginSDK = new Web3Login({ eventSubscriber });

await loginSDK.init()
```

### Dependencies Issues

#### WalletConnect
In file node_modules/@walletconnect/modal-core/dist/_types/index.d.ts
Export OpenOptions and ModalCtrlState
```typescript
export { ModalCtrl, OpenOptions } from './src/controllers/ModalCtrl';
export type { ConfigCtrlState, Listing, ListingResponse, MobileWallet, ModalEvent, RouterView, ThemeCtrlState, WalletData, ModalCtrlState } from './src/types/controllerTypes';
```
In file node_modules/@walletconnect/modal/dist/_types/src/client.d.ts
Implementation should look like this
```typescript
import type { ConfigCtrlState, ThemeCtrlState, OpenOptions, ModalCtrlState } from '@walletconnect/modal-core';
/**
 * Types
 */
export type WalletConnectModalConfig = ConfigCtrlState & ThemeCtrlState;
/**
 * Client
 */
export declare class WalletConnectModal {
    constructor(config: WalletConnectModalConfig);
    private initUi;
    openModal: (options?:  OpenOptions | undefined) => Promise<void>;
    closeModal: () => void;
    subscribeModal: (callback: (newState: ModalCtrlState) => void) => () => void;
    setTheme: (theme: ThemeCtrlState) => void;
}
```

#### Biconomy
In file node_modules/@biconomy/core-types/dist/src/AccountAbstractionTypes.d.ts
The first import should be:
```typescript
import { FallbackApiResponse, UserOperation } from './Types';
```


## Code documentation

For more details about the code please see the specific [documentation](./docs/modules.md).