🏃Getting Started

To start development with Startrail-Sdk-Js

NPM Package

https://www.npmjs.com/package/@startbahn/startrail-sdk-jswww.npmjs.com

Env

Tag

Staging

https://www.npmjs.com/package/@startbahn/startrail-sdk-js/v/next

Production

https://www.npmjs.com/package/@startbahn/startrail-sdk-js

Add Packages

npm install @startbahn/startrail-sdk-js

yarn add @startbahn/startrail-sdk-js

Script Tag

Please ensure to check and update to the latest version when you are developing.

<script src="https://cdn.jsdelivr.net/npm/@startbahn/startrail-sdk-js@1.34.0/dist/startrail-sdk.min.js"></script>

<script src="https://unpkg.com/@startbahn/startrail-sdk-js@1.34.0"></script>

Import

const StartrailSdk = require('@startbahn/startrail-sdk-js').Startrail
// or
import StartrailSdk from "@startbahn/startrail-sdk-js";

const startrail = new StartrailSdk(config)

Constructor

Configure and construct your Startrail SDK instance

new StartrailSdk(config)

Properties

All the properties listed below are optional.

Parameter

Type

Description

apiPath

string

Only define it if you want to do testing. For testing use the Test environment URL of STARTRAIL:

https://api-stg.startrail.startbahn.jp/api/v1

For production purpose do not define it.

wallet

'startrail' | 'metamask'

Wallet to activate. Default is startrail.

metamask: Metamask wallet installed in users' environment.
startrail: Google or Email/Password powered by Web3Auth.

env

string

The environment of Startrail-Api endpoint, blockchain network and Web3Auth environment.

production: Polygon mainnet. TORUS production account and Startrail production Auth0 account. It is designed to communicate to Startrail production API.
staging: Amoy testnet. TORUS production account and Startrail staging Auth0 account. It is designed to communicate to Startrail for testing.

authAction

{
  login: boolean
  signup: boolean
}

true hashes the preimage with keccak256

auth0ClientId

string

Client ID of Auth0 account

auth0Domain

string

Domain URL of Auth0

auth0TorusConfigKey

string

Config key name for TORUS initialisations to connect Auth0 domain and Web3Auth network. This key is only provided by Web3Auth

lang

 'ja' | 'en'

Language displayed on the UI

loginProvider

['google' | 'email_passwordless' | 'facebook' | 'twitter' | 'line' | 'apple' | 'email_password']

customUi

CustomUI

Values to customise UI only under Startrail wallet powered by Web3Auth. See more details in Whitelabeling/Customizing section.

callbackUrl

string

A URL to which a user is redirected after completing email verification with email_password

withModal

boolean

Startrail modal powered by Web3Auth is opened instead of direct procedure with a specific login action.

rpcEndpoint

string

An rpcEndpoint that is accessed from the wallet you select. See for more detail here.

chainId

number

An chainId that is accessed from the wallet you select. See for more detail here.

mfaLevel

"none" | "default" | "optional" | "mandatory"

default is none that is not asking for MFA. Further detail is here.

We recommend encouraging users to use this SDK in standard web browsers, such as Safari, Chrome, Firefox, etc. Some functionality of the SDK may not work properly in web-views.

// For Production (*No need to set auth0 or apiPath)
sdk = new Startrail({
  lang: 'ja',
  withModal: true,
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  lang: 'ja',
  withModal: true,
  env: 'staging', // torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

// For Production (*No need to set auth0 or apiPath)
sdk = new Startrail({
  lang: 'ja',
  loginProvider: ['google'],
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  lang: 'ja',
  loginProvider: ['google'],
  env: 'staging', // torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

// For Production (*apiPath setting is not required)
sdk = new Startrail({
  lang: 'ja',
  loginProvider: ['email_passwordless'],
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  lang: 'ja',
  loginProvider: ['email_passwordless'],
  env: 'staging', // torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

// For Production (*apiPath setting is not required)
sdk = new Startrail({
  lang: 'ja',
  loginProvider: ['line'],
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  lang: 'ja',
  loginProvider: ['line'],
  env: 'staging', // torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

// For Production (*apiPath setting is not required)
sdk = new Startrail({
  lang: 'ja',
  loginProvider: ['facebook'],
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  lang: 'ja',
  loginProvider: ['facebook'],
  env: 'staging', // torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

// For Production (*apiPath setting is not required)
sdk = new Startrail({
  lang: 'ja',
  loginProvider: ['apple'],
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  lang: 'ja',
  loginProvider: ['apple'],
  env: 'staging', // torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

// For Production (*apiPath setting is not required)
sdk = new Startrail({
  lang: 'ja',
  loginProvider: ['twitter'],
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  lang: 'ja',
  loginProvider: ['twitter'],
  env: 'staging', // torusBuildEnv is deprecate after v1.25.0
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

// For Production (*No need to set auth0 or apiPath)
sdk = new Startrail({
  env: 'production',
  wallet: 'metamask'
})

// For Development
sdk = new Startrail({
  apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
  env: 'staging',
  wallet: 'metamask'
})

// For Production (*No need to set auth0 or apiPath)
sdk = new Startrail({
  authAction: { login: false, signup: true },
  lang: 'ja',
  loginProvider: ['email_password'],
  env: 'production',　// torusBuildEnv is deprecate after v1.25.0
  redirectUrl: 'https://yoursite.com', // Not necessary for login
  customUi: {
    logoUrl: 'https://yoursite.com/logo',
    serviceName: 'your service name'
  }
})

// For Development
sdk = new Startrail({
　authAction: { login: false, signup: true },
　apiPath: 'https://api-stg.startrail.startbahn.jp/api/v1',
　lang: 'ja',
　loginProvider: ['email_password'],
　env: 'staging', // torusBuildEnv is deprecate after v1.25.0
　redirectUrl: 'https://yoursite.com', // Not necessary for login
　customUi: {
　　logoUrl: 'https://yoursite.com/logo',
　　serviceName: 'your service name'
　},
  // rpcEndpoint: 'your rpc endpoint url' // IF you want to designate endpoint
})

To connect to your wallet, use login method

await sdk.login()

See more details in Wallet Methods

Auth0, managed by Startbahn, is used for certain authentication methods, such as Email Password.

PreviousIntroduction NextRPC endpoint and chainId

Last updated 2 months ago

Was this helpful?

NPM Package

Add Packages

Script Tag

Import

Constructor

Properties

Sample Config Values For Each Login Method