Javascript SDK
SDK Configuration
Javascript SDK
SDK Configuration
var streambird = Streambird('pk_test_KJuRUZmh1XC342h1n39gH84MuSZDyD13NfhtDkaY6IfwpQA0H', {
headless: false,
networkConfig: {
rpcUrl: 'https://goerli.infura.io/v3/INFURA_API_KEY'
}
});
// see Options Example tab ^^
streambird.init(options);
{
eventType: 'EVENT_SUCCESS',
eventData: {
publicAddress: "xvPgUXBKTPUBrBdZWHajG17nWM59Zmx7s5NhXXXXXXX",
sessionJwt: "eyJhbGciOiJ...",
sessionToken: "TqXsQbXoTxKvjRAqVyLjrz8cRdQRM4enTUh9ixkoeClcgldtzs4LUxEB1XXXXXXX",
walletType: "SOL",
public_address: "xvPgUXBKTPUBrBdZWHajG17nWM59Zmx7s5NhXXXXXXX", // legacy field
session_token: "TqXsQbXoTxKvjRAqVyLjrz8cRdQRM4enTUh9ixkoeClcgldtzs4LUxEB1XXXXXXX", // legacy field
wallet_type: "SOL" // legacy field
}
}
options parameters
elementIdrequired
string
Refers to the DOM element to mount the SDK component UI.
e.g.
<div id="login"></div> here the elementId: "login"
enabledProductsrequired
[string]
Determines what products will be enabled within the SDK component UI. Possible values: emailMagicLink. Coming soon: oauth, smsOtp, emailOtp.
config
StreambirdClientProps Object
emailMagicLink
EmailMagicLinkOptions Object
This is the config for emailMagicLink and required if emailMagicLink is enabled in enabledProducts
wallet
Web3NetworkConfig Object
Determines what kind of wallet login to perform, if we cannot find any wallets for a new or existing user, we will provision a wallet of the specified type for this user.
componentStyle
ComponentStyleBase
Custom styling for the login UI component
callbacks
Object
Custom event handler functions for different events triggered within the SDK.
var streambird = Streambird('pk_test_KJuRUZmh1XC342h1n39gH84MuSZDyD13NfhtDkaY6IfwpQA0H', {
headless: false,
networkConfig: {
rpcUrl: 'https://goerli.infura.io/v3/INFURA_API_KEY'
}
});
// see Options Example tab ^^
streambird.init(options);
{
eventType: 'EVENT_SUCCESS',
eventData: {
publicAddress: "xvPgUXBKTPUBrBdZWHajG17nWM59Zmx7s5NhXXXXXXX",
sessionJwt: "eyJhbGciOiJ...",
sessionToken: "TqXsQbXoTxKvjRAqVyLjrz8cRdQRM4enTUh9ixkoeClcgldtzs4LUxEB1XXXXXXX",
walletType: "SOL",
public_address: "xvPgUXBKTPUBrBdZWHajG17nWM59Zmx7s5NhXXXXXXX", // legacy field
session_token: "TqXsQbXoTxKvjRAqVyLjrz8cRdQRM4enTUh9ixkoeClcgldtzs4LUxEB1XXXXXXX", // legacy field
wallet_type: "SOL" // legacy field
}
}