SSX is a library that enables you to easily add user authentication, session management, and more to your dapp.
./packages/ssx-sdk../packages/ssx-server.yarn build - Build all packagesyarn run-examples - Concurrently run the example server and app found in ./examplesyarn clean && npx lerna clean -y - Remove all build artifacts and node_modulesThis change allows for updated configuration options to be passed to SSX client to allow for a higher level of configurability for the SSX endpoints.
yarn dev results in an error:
![[BUG] Running a ssx-test-express-api server in development results in an error](https://avatars.githubusercontent.com/u/1234129?v=4)
6:58:59 PM - Starting compilation in watch mode...
[0]
[1] /Users/art/Code/OSS/ssx/node_modules/ts-node/src/index.ts:859
[1] return new TSError(diagnosticText, diagnosticCodes, diagnostics);
[1] ^
[1] TSError: ⨯ Unable to compile TypeScript:
[1] src/index.ts(5,93): error TS2307: Cannot find module '@spruceid/ssx-server' or its corresponding type declarations.
[1] src/index.ts(39,12): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[1] src/index.ts(43,42): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[1] src/index.ts(47,17): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[1]
[1] at createTSError (/Users/art/Code/OSS/ssx/node_modules/ts-node/src/index.ts:859:12)
[1] at reportTSError (/Users/art/Code/OSS/ssx/node_modules/ts-node/src/index.ts:863:19)
[1] at getOutput (/Users/art/Code/OSS/ssx/node_modules/ts-node/src/index.ts:1077:36)
[1] at Object.compile (/Users/art/Code/OSS/ssx/node_modules/ts-node/src/index.ts:1433:41)
[1] at Module.m._compile (/Users/art/Code/OSS/ssx/node_modules/ts-node/src/index.ts:1617:30)
[1] at Module._extensions..js (node:internal/modules/cjs/loader:1213:10)
[1] at Object.require.extensions.<computed> [as .ts] (/Users/art/Code/OSS/ssx/node_modules/ts-node/src/index.ts:1621:12)
[1] at Module.load (node:internal/modules/cjs/loader:1037:32)
[1] at Function.Module._load (node:internal/modules/cjs/loader:878:12)
[1] at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:82:12) {
[1] diagnosticCodes: [ 2307, 2339, 2339, 2339 ]
[1] }
[1] [nodemon] app crashed - waiting for file changes before starting...
[0] src/index.ts(5,93): error TS2307: Cannot find module '@spruceid/ssx-server' or its corresponding type declarations.
[0] src/index.ts(39,12): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[0] src/index.ts(43,42): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[0] src/index.ts(47,17): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[0] src/redis.ts(5,93): error TS2307: Cannot find module '@spruceid/ssx-server' or its corresponding type declarations.
[0] src/redis.ts(41,15): error TS7006: Parameter 'session' implicitly has an 'any' type.
[0] src/redis.ts(63,12): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[0] src/redis.ts(67,42): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[0] src/redis.ts(71,17): error TS2339: Property 'ssx' does not exist on type 'Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>'.
[0]
[0] 6:59:00 PM - Found 9 errors. Watching for file changes.
Server is expected to start
Env Node version: v19.0.1 OS: Darwin Kernel Version 22.1.0: root:xnu-8792.41.9~2/RELEASE_ARM64_T6000
git clone https://github.com/spruceid/ssx.gitcd ssx/examples/ssx-test-express-apiyarnyard devNo response
Implementing SSX Server in a serverless environment was a difficult task since the behavior is not decoupled enough. With that in mind this PR introduces a new package ssx-serverless that is a custom implementation of ssx-server focusing on environments that requires a totally custom configuration.
This PR passes a flag to siwe in ssx-middleware to prevent exceptions from causing the middleware to crash. More context on suppressExceptions
Builds with Gulp throw errors due to issues resolving "duplicate" exports. This change breaks up how we export modules in ssx-core and ands an example building with Gulp to the monorepo to test this and future changes.
This updates the test script by adding some flags to prevent open handles. Due to these open handles, the build workflow was taking more than 10 minutes to complete.
This adds an ENS resolution feature to the client and server packages, allowing the developer to choose where to resolve it. The client resolution will override it If it is enabled in both. This also updates the examples to reflect the latest changes.
Node Version: 16.13.1 OS: ubuntu 20.04 Browser Version: Chrome 108.0.5359.94
This PR bumps the patch versions of the libraries in the SSX Monorepo to v1.1.1. It has imporovements to ssx-core, ssx-server and ssx-sdk
Update to the documentation branch to sync with Gitbook. Archived current documentation as v1.0.0 in respective folders.
Updates the documentation branch to reflect the latest changes in main now that we have a new release in order to auto-generate our hosted documentation.
Note: Merging auto-updates the documentation.
Several dependency updates in both the package.json and the yarn.lock files have been updated to address issues from dependabot.
This PR adds support for NextAuth to ssx-react and a corresponding example (ssx-test-nextauth). This PR touches a lot of things! Changes include creating new packages, refactoring ssx-server, and updating ssx-react. Some of the changes were made while debugging next stuff, but were not the eventual solution. I left them in for refactor purposes. I'll highlight them! Please comment on any refactor changes as well as new packages.
Updated packages:
ssx-coressx-serverssx-reactNew Packages
ssx-server-middlewareUpdate the ssx configuration to accept updated parameters for the server routes. These routes can now accept a more complex configuration, allow for different connections to different backends.
const ssx = new SSX({
providers: {
server: {
host: 'http://ssx-server-host.com'
routes: {
nonce: {
url: '/ssx-custom-nonce',
method: 'post'
}
}
}
}
});
SSXServerRoutes type to accept a route configuration compatible with Axios Request Config to allow for more complex server configurations.SSXServerRoutes type to SSXServerRouteNames to reflect usage in ssx-serverSSXServerRoutes type to SSXServerRouteNames to reflect usage in ssx-serverSSXServerRoutes type to accept a route configuration compatible with Axios Request Config to allow for more complex server configurations.83c314c: Enable custom paths for endpoints on client and server.
Due to the change in SSXClientConfig, it now accepts the server's routes configuration:
const ssx = new SSX({
providers: {
server: {
host: 'http://localhost:3001',
routes: {
nonce: '/ssx-custom-nonce',
login: '/ssx-custom-login',
logout: '/ssx-custom-logout',
}
}
}
});
This is an optional configuration and the default values are: nonce: '/ssx-nonce', login: '/ssx-login', logout: '/ssx-logout'. It isn't necessary to override all of them, you can only override one of them.
@spruceid/ssx-core as a dependency;ssx-core;SSXConfig (deprecated) and SSXClientConfig;SSXProviders (deprecated) and SSXClientProviders;SSXSession (deprecated) and SSXClientSession;ssx-core;try/catch blocks;examples/ssx-test-dapp to support ENS resolution from examples/ssx-test-serverless-dynamodb-api.SiweMessage from the siwe dependency.c989838: Refactor code to avoid duplication and improve performance.
@spruceid/ssx-core as a dependency;ssx-core;ssx-core;try/catch blocks;"^0.27.2";examples/ssx-test-serverless-dynamodb-api to resolve ENS according to the request params and fixes the /ssx-login JSON response.Updated dependencies [c989838]
Updated dependencies [83c314c]
83c314c: Enable custom paths for endpoints on client and server. This now accepts the routes configuration when instantiating the middlewares as follows:
const expressMiddleware = SSXExpressMiddleware(ssx, {
nonce: '/ssx-custom-nonce',
login: '/ssx-custom-login',
logout: '/ssx-custom-logout',
});
// or
const httpMiddleware = SSXHttpMiddleware(ssx, {
nonce: '/ssx-custom-nonce',
login: '/ssx-custom-login',
logout: '/ssx-custom-logout',
});
The second parameter with the configuration object is optional and the default values are: nonce: '/ssx-nonce', login: '/ssx-login', logout: '/ssx-logout'. It isn't necessary to override all of them, you can only override one of them.
c989838: Refactor code to avoid duplication and improve performance.
@spruceid/ssx-core as a dependency;ssx-core;SSXConfig (deprecated) and SSXServerConfig;SSXProviders (deprecated) and SSXServerProviders;ssx-core;try/catch blocks.c66f308: Include and export SiweMessage from the siwe dependency.
Updated dependencies [c989838]
Updated dependencies [83c314c]
c989838: Refactor code to avoid duplication and improve performance.
ssxConfig?: SSXConfig; on SSXProviderProps to ssxConfig?: SSXClientConfig; (non breaking change).Updated dependencies [c989838]
Updated dependencies [c66f308]
Updated dependencies [83c314c]
c989838: Refactor code to avoid duplication and improve performance.
@spruceid/ssx-core as a dependency;ssx-core to all SSX related variables;try/catch blocks.Updated dependencies [c989838]
Updated dependencies [83c314c]
We're excited to announce the first release of SSX Core, a package holds the core types, commonly reused components and logic throughout SSX. This package helps us write better, more testable and maintainable code.
@spruceid/ssx-sdk: SSXConfig -> SSXClientConfig;@spruceid/ssx-sdk: SSXProviders -> SSXClientProviders;@spruceid/ssx-sdk: SSXSession -> SSXClientSession;@spruceid/ssx-server: SSXConfig -> SSXServerConfig;@spruceid/ssx-server: SSXProviders -> SSXServerProviders;SSXServerRoutes interfaceroutes?: SSXServerRoutes to SSXClientConfig.providers.server.SSX instance. This configuration isn't mandatory;SSXSession interface to add ens: SSXEnsData as optional property;ssx.signIn() to resolve ENS data according to the SSX config. This method now sends resolveEns param to the /ssx-login request;ssx.resolveEns(...) method to resolve ENS data on client;ssx.session;ssx-test-dapp to conform with the latest changes.1072382: Add ENS resolution feature to the client and server to allow the developer to choose where to resolve it.
Updated dependencies [f317c82]
ssx.resolveEns(...) method to resolve ENS data;/ssx-login responses were updated. These requests were returning a session object with a session property. Now it returns a session object without the session property, but keeping all information;ssx-test-express-api and ssx-test-http-api to conform with the latest changes.spaceIds now will be used for delegation. For SIWE spaceIds are keccak256("siwe" + delegate.address). This allows for multi-delegation per Safe.
Updated event filters to instead of filter only by delegate.address to also filter by spaceIds.
Delegations made outside the new space will not be displayed.
All delegations will need to be re-made under the new spaceId
This updates the ssx-sdk to give more context and flexibility to the ssx-powered server when manipulating the session.
ssx-sdk getNonce, signIn and signOut requests send more parameters to the ssx-powered server to give more context and flexibility when manipulating the session.
We added more parameters to the requests as follow:
/ssx-nonce now passes address, chainId, domain and issuedAt as query parameters/ssx-login and /ssx-logout now passes all session information (siwe, signature, address, walletAddress, chainId and daoLogin) as bodyNone
Source code(tar.gz)We're excited to announce the first release of SSX-react, a package that enables you to easily add ssx to React and Next.js applications. This package provides a React Provider and Hook to access ssx in your components.
Check out the ssx-react documentation for more information on how to get started with ssx-react.
We're excited to announce the first release of SSX Serverless, a library that enables you to easily integrate Sign-In with Ethereum on your serverless app for authenticating users, managing sessions, understanding user metrics, and much more.
Check out the SSX Serverless documentation for more information on how to get started.
This updates the dapp template's design to match the ssx-test-dapp, and changes 'Delegation History' to 'Dao Login' when asking to enable features during setup.
We're excited to announce the first release of SSX, a library that enables you to easily integrate Sign-In with Ethereum for authenticating users, managing sessions, understanding user metrics, and much more.
We've made it simple to add SSX to both your frontend client app, as well as your backend server with minimal configuration.
Check out the SSX documentation for more information on how to get started.
We're excited to announce the first release of SSX Server, a library that enables you to easily integrate Sign-In with Ethereum on your server for authenticating users, managing sessions, understanding user metrics, and much more.
Check out the SSX Server documentation for more information on how to get started.
We're excited to announce the first release of SSX Gnosis Extension, a package that enables the main SSX package to enable users to log in on behalf of DAOs via the delegate registry smart contract by enabling a flag called enableDaoLogin. To learn more about how this works in SSX, check out the SSX DAO Login documentation.
create-ssx-dapp v0.1.0We're excited to announce the first release of Create SSX Dapp, a package that enables you to easily create a new SSX dapp with a single command. It aims to be the simplest way to get a dapp started that integrates Sign-In with Ethereum for authenticating users, managing sessions, understanding user metrics, and much more.
Check out the SSX documentation for more information on how to get started with Create SSX Dapp.
Annotator Annotator is a JavaScript library for building annotation applications in browsers. It provides a set of interoperable tools for annotating
Blog Web app A simple webapp prototype that serves tech news, blogs, and anythin
LIVE DEMO: https://armytracker.com/ (tracking the invading Russian army in Ukraine) Attention: - If you'd like to help the project either as a program
opgg-use-device-detector Check your device when you have anything to change on your PC or mobile. ❤️ it? ⭐️ it on GitHub opgg-use-device-detector basi
JSON Visio is data visualization tool for your json data which seamlessly illustrates your data on graphs without having to restructure anything, paste directly or import file.
AI powered web scraper that let's you scrape anything you want from the web including google web search results from your terminal. And at the same ti
HackFest is a 36-hour long hackathon wherein you have to put on your hacker hats and build anything that falls in either or both the domain of full-stack web development (the stack we learn in full-stack web developer roadmap on codedamn).
Want to preserve your loved one's voices for eternity? Narrate anything using the a voice imprint that can be made in as little as 10 minutes of audio samples. Easy as pie.
Next + TypeScript + Eslint + Prettier Template ?? Create a new project with Next.js, TypeScript, Eslint, Prettier in just 1 second and you don't need
Rate Limiter - built for Cloudflare Workers, using Durable Objects Features Supports fixed or sliding window algorithms Scoped rate-limiting Caching C
?? Premium - ?? Builder - ?? Features Authors GhostyXD#0202 Rundeun#1337 Contributors Florin#5231 Kokto#3333 bbystealer The new modern discord token g
Uptime Kuma It is a self-hosted monitoring tool like "Uptime Robot". Features Monitoring uptime for HTTP(s) / TCP / Ping. Fancy, Reactive, Fast UI/UX.
Photostore Photostore is a self-hosted, client-server solution for backing up, viewing and downloading photos. How it works The Photostore API (writte
Obsidian Export Obsidian Publish is great but lacks support for many of the plugins we Obsidian addicts have grown accustomed to — in particular Datav
Muboard Muboard is a tiny utility that runs a mathematics display board as a web page. Muboard lets you quickly scribble mathematics snippets using Ma
Touca Touca helps you see the side-effects of your changes, as you write code. Touca SDKs let you describe the behavior and performance of your softwa
DropSpace Simple file sharing made in Laravel About DropSpace DropSpace is an easy way to self-host a file drop. Simply upload your file, and share th
minBin A minimal & self-hostable alternative to pastebin intended for code Use ⌨️ A public instance is available at https://bin.kio.dev/ Building ?? n
pdf-digital-signature-with-node-signpdf-ejs I'm trying to create simple program for adding the digital signature to a pdf file with self-signed certif
2.6k Dec 23, 2022
6 Nov 3, 2022
9 Mar 27, 2022
11 Aug 6, 2022
20.6k Jan 4, 2023
27 Dec 27, 2022
2 Jun 6, 2022
15 Nov 29, 2022
11 Oct 2, 2022
11 Dec 15, 2022
4 Mar 16, 2023
27.4k Jan 3, 2023
38 Oct 25, 2022
12 Nov 28, 2022
539 Dec 15, 2022
135 Dec 30, 2022
25 Dec 9, 2022
4 Dec 29, 2022
5 Dec 25, 2022