Login With GoodDollar
An SDK that allows the user to share his details
GoodDollar Login SDK
https://github.com/GoodDollar/GoodWeb3-Mono/tree/master/packages/login-sdk
This is the gooddollar client sdk for integrating login into gooddollar in your website
Example App to test the functionality
Install
SDK Utilities
createLoginLink to generate login link to redirect to the gooddollar wallet
LoginButton to place a login button on your page to integrate login with gooddollar on your website
parseLoginResponse to verify if the login was successful and verified
useLogin is a hook that can be used instead of button to integrate login with gooddollar on your website
Object schema for createLoginLink
Property Name | Purpose | Mandatory/Optional | Type |
---|---|---|---|
redirectLink | gooddollar wallet link to redirect to | Optional | String |
v | name of the vendor | Mandatory | String |
web | web link for vendor | Mandatory | String |
id | wallet address for vendor | Mandatory | String |
r | array of information ex.['mobile','location'] | Mandatory | array |
cbu | Callback URL | provide either rdu or cbu | String |
rbu | Redirect URL | provide either rdu or cbu | String |
Object schema for useLogin
Property Name | Purpose | Mandatory/Optional | Type |
---|---|---|---|
gooddollarlink | wallet link returned by createLoginLink | Mandatory | String |
cbu | Callback URL | provide either rdu or cbu | String |
rbu | Redirect URL | provide either rdu or cbu | String |
onLoginCallback | Function that has the data returned by wallet as the first argument | Mandatory | Function |
Props for LoginButton
Prop Name | Purpose | Mandatory/Optional | Type |
---|---|---|---|
gooddollarlink | wallet link returned by createLoginLink | Mandatory | String |
cbu | Callback URL | provide either rdu or cbu | String |
rbu | Redirect URL | provide either rdu or cbu | String |
onLoginCallback | Function that has the data returned by wallet as the first argument | Mandatory | Function |
example login with hook
example login with button
Last updated