@startbahn/startrail-sdk-js 1.27.1 → 1.28.0

package/README.md

@@ -43,8 +43,8 @@ const startrail = new Startrail(params)
   - `env` (optional): Environment that impacts on blockchain network, and EOA with startrail Email/Password
     - `production`: Matic network. TORUS production account and Startrail production Auth0 account. It is designed to communicate to Startrail production API.
     - `staging`: Mumbai network. TORUS production account and Startrail staging Auth0 account. It is designed to communicate to Startrail staging API.
-    - `beta`: Mumbai network. TORUS beta account and Startrail qa Auth0 account. It is designed to communicate to Startrail qa API.
-    - `local`: https://localhost:8545 network for local dev. TORUS beta account and Startrail beta Auth0 account. It is designed to communicate to localhost API.
+    - `lrc`: Mumbai network. TORUS lrc account and Startrail qa Auth0 account. It is designed to communicate to Startrail qa API.
+    - `local`: https://localhost:8545 network for local dev. TORUS lrc account and Startrail lrc Auth0 account. It is designed to communicate to localhost API.
 
 [For Startrail wallet powered  by TORUS]
   - `authAction` (optional): Activate only selected action tab on the Email popup. Wording is also changed based on your choice. It points to 
@@ -59,12 +59,13 @@ const startrail = new Startrail(params)
     - `ja`: Japanese
   - `loginProvider` (optional): Login provider preference
     - `email_password`: Email Password login
-    - `google`: Google Oauth Login 
-  - `customUi`: Customising UI. If no parameters are set, default values are applied. 
+    - `google`: Google Oauth Login
+  - `customUi`: Customising UI. If no parameters are set, default values are applied.
     - `logoUrl`: Applied to all logos in Startrail-sdk-js
     - `serviceName`: Applied to all service name in Startrail-sdk-js
     - `contactUrl`: Applied to the contact email in signup Email verification email
     - `words`: See more details in Example section
+    - `logoWhiteUrl`: Applied to all white logos on black background in Startrail-sdk-js
   - `callbackUrl` (optional): Callback URL to redirect to from E-Mail template for signup verification
   - `withModal` (optional): Specifies if the Torus Login Provider Modal should be shown. Default value is set to `false`
   - `rpcEndpoint` (optional): RpcEndpoint that is accessed from the wallet you login/signup
@@ -76,7 +77,7 @@ const startrail = new Startrail(params)
 ```
 sdk = new Startrail({
   apiPath:'http://localhost:3000/api/v1/',
-  env: 'beta',
+  env: 'lrc',
   wallet: 'startrail',
   authAction: { login: true, signup: false },
   auth0ClientId: 'test-auth0-client-id',
@@ -88,6 +89,7 @@ sdk = new Startrail({
   withModal: true,
   customUi: {
     logoUrl: 'https://sample.com/logo',
+    logoWhiteUrl: 'https://sample.com/white-logo',
     serviceName: 'your service',
     contactUrl: 'contact@startrail.io',
     words: {
@@ -95,7 +97,8 @@ sdk = new Startrail({
         modal: {
           continueLogin: 'Login with previous {verifier} account', // {verifier} is optional but to be replaced programmatically with the login provider name if it exists in the sentence
           termsConditions: 'your termsConditions',
-          termsConditionsLinkUrl: 'your termsConditionsLinkUrl'
+          termsConditionsLinkUrl: 'your termsConditionsLinkUrl',
+          privacyPolicyLinkUrl: 'your privacyPolicyLinkUrl'
         },
         signPopup: {
           title: 'your title',
@@ -113,7 +116,8 @@ sdk = new Startrail({
         modal: {
           continueLogin: '前回の{verifier}アカウントを使う', // {verifier}は任意ですが、文言の中に存在していれば選択したログイン方法の名前へと自動的に置き換わります。
           termsConditions: 'あなたの termsConditions',
-          termsConditionsLinkUrl: 'あなたの termsConditionsLinkUrl'
+          termsConditionsLinkUrl: 'あなたの termsConditionsLinkUrl',
+          privacyPolicyLinkUrl: 'あなたの privacyPolicyLinkUrl'
         },
         signPopup: {
           title: 'あなたの title',
@@ -126,6 +130,7 @@ sdk = new Startrail({
           titleLogin: 'あなたの titleLogin',
           titleSignup: 'あなたの titleSignup'
         }
+      }
     }
   }
 })
@@ -133,4 +138,4 @@ sdk = new Startrail({
 
 ## Tips
 If you use Metamask, call sdk.login() before requesting users to sign or call API, in order to fetch currently active EOA and compare
-it in your web-application, because it is not possible by SDK to stop users from switching EOA.
+it in your web-application, because it is not possible by SDK to stop users from switching EOA.