|
1 | | -# fast-auth |
| 1 | +# FastAuth |
2 | 2 |
|
3 | | -## Features |
| 3 | +## Overview |
4 | 4 |
|
5 | | -### Login |
| 5 | +- **[Contracts](./contracts/)** - NEAR smart contracts handling JWT verification and transaction signing |
6 | 6 |
|
7 | | -- Login through Auth0 to generate a plain JWT token. |
| 7 | + - [auth0-guard](./contracts/auth0-guard/) - Auth0 JWT verification contract |
| 8 | + - [fa](./contracts/fa/) - FastAuth main contract |
| 9 | + - [jwt-guard-router](./contracts/jwt-guard-router/) - JWT routing contract |
8 | 10 |
|
9 | | -### Sign and send transaction |
| 11 | +- **[Browser SDK](./packages/sdks/browser/)** - Client-side library for integrating FastAuth into web applications |
10 | 12 |
|
11 | | -- Generate a JWT with the transaction to sign. |
12 | | -- The sender should have a login JWT. |
13 | | -- The transaction actions must match NEAR actions. |
14 | | -- The JWT is sent to the contract to verify the transaction. |
15 | | -- The contract should autofill the transaction, sign it and send it to the network. |
| 13 | +- **[Auth0 Components](./packages/auth0/)** - Auth0 specific integration components |
16 | 14 |
|
17 | | -### Implementation |
| 15 | +- **[Examples](./examples/)** - Reference implementations for different integration patterns |
18 | 16 |
|
19 | | -#### Auth0 |
| 17 | + - [SPA Example](./examples/spa/) - Single Page Application integration |
| 18 | + - [Custom Backend](./examples/custom-backend/) - Express.js backend example |
| 19 | + - [Wallet Integration](./examples/wallet/) - Wallet integration example |
20 | 20 |
|
21 | | -##### Login |
22 | | - |
23 | | -- Set up modal displaying |
24 | | - - [ ] DApp name |
25 | | - - [ ] DApp logo |
26 | | -- Return the JWT to the frontend |
27 | | - |
28 | | -##### Sign and send transaction |
29 | | - |
30 | | -- Inject tx custom claim with the transaction to sign. |
31 | | -- Set up modal displaying |
32 | | - - [ ] Actions |
33 | | - - [ ] Transfer |
34 | | - - [ ] Function call |
35 | | - - [ ] DeployContract |
36 | | - - [ ] AddKey |
37 | | - - [ ] DeleteKey |
38 | | - - [ ] ReceiverID |
39 | | -- Return the signed transaction to the frontend. |
40 | | - |
41 | | -#### Contract |
42 | | - |
43 | | -- [ ] `add_guard` method permissionless |
44 | | -- [ ] sign the transaction on-chain. |
45 | | -- [ ] Return the signed transaction to the frontend. |
| 21 | +- **[Documentation](./docs/)** - Comprehensive guides and API references |
0 commit comments