README

Search…
0.1.0
This package allows Web3 enabled browsers the authenticate with Firebase. Access roles are assigned based on the wallet's locks.
Installation
Functions needed for cloud functions and in the browser are available via npm , browser capability can also be enabled via CDN for those not using a bundler.
Node.js
CDN
1
$ npm i @novum/unlock-firebase-integration
Copied!
1
<script type="text/javascript"
2
    src="https://unpkg.com/@novuminsights/unlock-protocol-firebase/lib/browser.js"></script>
Copied!
Authentication
This package allows wallet holders to log in to Firebase Authentication by verifying wallet ownership via signed message. No additional information is required. If you are using other authentication providers, I'd recommend merging user created in this way and using AccountClaimReader in @novum/unlock-firebase-integration/server/helpers  to maintain user claims in a custom manner. 
Enabling Cloud Function authentication with for Wallet Users 
That's all you need for the backend:
functions/src/index.js
1
//initialize you app as you normally would
2
import * as admin from "firebase-admin";
3
admin.initializeApp();
4
​
5
//expose getLockFirebaseToken and createMessageToken as you would any other function
6
export {getLockFirebaseToken, createMessageToken} from "@novuminsights/unlock-protocol-firebase/lib/server";
Copied!
Additionally, you need to set a secret:
1
$ firebase functions:config:set unlock.secret="Any String you can keep secret!"
Copied!
On the front-end, just call signInWithWeb3. For example, using a button:
Bundler
CDN
1
import "firebase/auth"
2
import "firebase/functions"
3
import {signInWithWeb3} from '@novum/unlock-firebase-integration/lib/browser'
4
​
5
const app = firebase.initializeApp(firebaseConfig);
6
const signInButton = document.querySelector('#MyButton')
7
signInButton.onclick = () => signInWithWeb3(app);
Copied!
1
<script src="https://www.gstatic.com/firebasejs/8.8.1/firebase-app.js"></script>
2
<script src="https://www.gstatic.com/firebasejs/8.8.1/firebase-functions.js"></script>
3
<script src="https://www.gstatic.com/firebasejs/8.8.1/firebase-auth.js"></script>
4
<script type="text/javascript"
5
    src="https://unpkg.com/@novuminsights/unlock-protocol-firebase/lib/browser.js"></script>
6
....
7
<script>
8
    const app = firebase.initializeApp(firebaseConfig);
9
    const signInButton = document.querySelector('#MyButton')
10
    signInButton.onclick = async () => {
11
        await unlockProtocolFirebaseBrowser.signInWithWeb3(app)
12
    };
13
</script>
Copied!
Controlling Access Through Locks
This integration uses the Unlock Protocol locks held in a wallet to assign access roles to Firebase users via Firebase's custom claims (assessed on login). 
Mapping locks to roles
Custom claims are assigned to the user upon authentication based on the locks the wallet currently has. The mapping from lock addresses to claims is  defined in unlock-integration-config.json, like so:
functions/unlock-integration.config.json
1
{
2
    "networks": {
3
        "mainnet": {
4
            "provider_url": "https://mainnet.infura.io/v3/678543fed855441b7b642730944ee4469",
5
            "locks": {
6
                "0x361Ddf540e27632D80dDE806EAa76AC42A0e15F6": ["basic_subscription"]
7
            }
8
        },
9
        "rinkby": {}
10
    },
11
  "default_network": "mainnet",
12
  "default_claims": ["wallet_owner"]
13
}
Copied!
You can define multiple networks, but currently only one network is used at a time. You can set which network will be used for a particular project via firebase functions config like so:
1
$ firebase functions:config:set unlock.network=rinkby
Copied!
Otherwise, default_network as defined in unlock-integration-config.json is used. This is useful for testing with Rinkby. Support for multiple active networks can be added in the future.
Using claims for role-based access
You can access these claims directly from the user's token --- for example, in your Firestore rules:
firestore.rules
1
rules_version = '2';
2
service cloud.firestore {
3
  match /databases/{database}/documents {
4
      match /{document=**} {
5
      allow read, write: if false;
6
    }
7
    function hasSubscription() {
8
      return request.auth != null && request.auth.token.basic_subcriptionic_sub;
9
    }
10
    match /app_data/top_pairs {
11
          allow read: if hasSubscription();
12
    }
13
}
14
​
Copied!
 As well as, your Firebase functions:
1
async function hasBasicSubscription(context) {
2
    const auth = context.auth;
3
    ...
4
    return auth.token.basic_subscription === true;
5
}
Copied!
or in the browser:
1
export async function canViewDashboard(user) {
2
    const result = await user.getIdTokenResult(true);
3
    return (result.claims.basic_subscription === true);
4
}
Copied!
Example Project
An example project can be found it example/ . You will need to add your own project credentials as it uses Firebase Auth.
Last modified 10mo ago
Copy link
Contents
Installation
Authentication
Enabling Cloud Function authentication with for Wallet Users
Controlling Access Through Locks
Mapping locks to roles
Using claims for role-based access
Example Project