@startbahn/startrail-sdk-js 1.24.0-beta.3 → 1.25.0-beta.2

package/README.md

@@ -92,6 +92,7 @@ sdk = new Startrail({
     words: {
       en: {
         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'
         },
@@ -109,6 +110,7 @@ sdk = new Startrail({
       },
       ja: {
         modal: {
+          continueLogin: '前回の{verifier}アカウントを使う', // {verifier}は任意ですが、文言の中に存在していれば選択したログイン方法の名前へと自動的に置き換わります。
           termsConditions: 'あなたの termsConditions',
           termsConditionsLinkUrl: 'あなたの termsConditionsLinkUrl'
         },

package/dist/startrail-sdk.js

@@ -164726,7 +164726,7 @@ const torusConfig = (config) => {
                 showOnModal: false
             },
             [config.auth0TorusConfigKey]: {
-                name: ' ',
+                name: 'email',
                 typeOfLogin: 'email_password',
                 description: 'login.buttonText',
                 clientId: config.auth0ClientId,
@@ -164769,7 +164769,7 @@ const isSignup = (config) => {
  * Format data passed from end-users for torus-embed configuration
  */
 const formatConfigForTorusUI = (config) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3;
     let customUi = {};
     let lang;
     const tkeyDesc = {
@@ -164784,19 +164784,20 @@ const formatConfigForTorusUI = (config) => {
                     yourDigital: config.conditionalWords.subtitle[lang],
                     signIn: config.conditionalWords.authLabel[lang],
                     termsConditions: ((_d = (_c = (_b = (_a = config === null || config === void 0 ? void 0 : config.customUi) === null || _a === void 0 ? void 0 : _a.words) === null || _b === void 0 ? void 0 : _b[lang]) === null || _c === void 0 ? void 0 : _c.modal) === null || _d === void 0 ? void 0 : _d.termsConditions) || constant_1.DEFAULT_WORD.dappLogin.termsConditions[lang],
-                    termsLearnMore: '' // Remove additional link from modal
+                    termsLearnMore: '',
+                    continueWith: ((_h = (_g = (_f = (_e = config === null || config === void 0 ? void 0 : config.customUi) === null || _e === void 0 ? void 0 : _e.words) === null || _f === void 0 ? void 0 : _f[lang]) === null || _g === void 0 ? void 0 : _g.modal) === null || _h === void 0 ? void 0 : _h.continueLogin) || constant_1.DEFAULT_WORD.dappLogin.continueWith[lang]
                 },
                 login: {
                     buttonText: config.conditionalWords.emailButton[lang]
                 },
                 dappTransfer: {
-                    permission: ((_h = (_g = (_f = (_e = config === null || config === void 0 ? void 0 : config.customUi) === null || _e === void 0 ? void 0 : _e.words) === null || _f === void 0 ? void 0 : _f[lang]) === null || _g === void 0 ? void 0 : _g.signPopup) === null || _h === void 0 ? void 0 : _h.title) || constant_1.DEFAULT_WORD.dappTransfer.permission[lang],
-                    data: ((_m = (_l = (_k = (_j = config === null || config === void 0 ? void 0 : config.customUi) === null || _j === void 0 ? void 0 : _j.words) === null || _k === void 0 ? void 0 : _k[lang]) === null || _l === void 0 ? void 0 : _l.signPopup) === null || _m === void 0 ? void 0 : _m.dataToSign) || constant_1.DEFAULT_WORD.dappTransfer.data[lang]
+                    permission: ((_m = (_l = (_k = (_j = config === null || config === void 0 ? void 0 : config.customUi) === null || _j === void 0 ? void 0 : _j.words) === null || _k === void 0 ? void 0 : _k[lang]) === null || _l === void 0 ? void 0 : _l.signPopup) === null || _m === void 0 ? void 0 : _m.title) || constant_1.DEFAULT_WORD.dappTransfer.permission[lang],
+                    data: ((_r = (_q = (_p = (_o = config === null || config === void 0 ? void 0 : config.customUi) === null || _o === void 0 ? void 0 : _o.words) === null || _p === void 0 ? void 0 : _p[lang]) === null || _q === void 0 ? void 0 : _q.signPopup) === null || _r === void 0 ? void 0 : _r.dataToSign) || constant_1.DEFAULT_WORD.dappTransfer.data[lang]
                 },
                 dappProvider: {
-                    requestFrom: ((_r = (_q = (_p = (_o = config === null || config === void 0 ? void 0 : config.customUi) === null || _o === void 0 ? void 0 : _o.words) === null || _p === void 0 ? void 0 : _p[lang]) === null || _q === void 0 ? void 0 : _q.signPopup) === null || _r === void 0 ? void 0 : _r.requestFrom) || constant_1.DEFAULT_WORD.dappProvider.requestFrom[lang],
-                    confirm: ((_v = (_u = (_t = (_s = config === null || config === void 0 ? void 0 : config.customUi) === null || _s === void 0 ? void 0 : _s.words) === null || _t === void 0 ? void 0 : _t[lang]) === null || _u === void 0 ? void 0 : _u.signPopup) === null || _v === void 0 ? void 0 : _v.confirm) || constant_1.DEFAULT_WORD.dappProvider.confirm[lang],
-                    cancel: ((_z = (_y = (_x = (_w = config === null || config === void 0 ? void 0 : config.customUi) === null || _w === void 0 ? void 0 : _w.words) === null || _x === void 0 ? void 0 : _x[lang]) === null || _y === void 0 ? void 0 : _y.signPopup) === null || _z === void 0 ? void 0 : _z.cancel) || constant_1.DEFAULT_WORD.dappProvider.cancel[lang]
+                    requestFrom: ((_v = (_u = (_t = (_s = config === null || config === void 0 ? void 0 : config.customUi) === null || _s === void 0 ? void 0 : _s.words) === null || _t === void 0 ? void 0 : _t[lang]) === null || _u === void 0 ? void 0 : _u.signPopup) === null || _v === void 0 ? void 0 : _v.requestFrom) || constant_1.DEFAULT_WORD.dappProvider.requestFrom[lang],
+                    confirm: ((_z = (_y = (_x = (_w = config === null || config === void 0 ? void 0 : config.customUi) === null || _w === void 0 ? void 0 : _w.words) === null || _x === void 0 ? void 0 : _x[lang]) === null || _y === void 0 ? void 0 : _y.signPopup) === null || _z === void 0 ? void 0 : _z.confirm) || constant_1.DEFAULT_WORD.dappProvider.confirm[lang],
+                    cancel: ((_3 = (_2 = (_1 = (_0 = config === null || config === void 0 ? void 0 : config.customUi) === null || _0 === void 0 ? void 0 : _0.words) === null || _1 === void 0 ? void 0 : _1[lang]) === null || _2 === void 0 ? void 0 : _2.signPopup) === null || _3 === void 0 ? void 0 : _3.cancel) || constant_1.DEFAULT_WORD.dappProvider.cancel[lang]
                 },
                 dappCreateTkey: {
                     linkDesc1: tkeyDesc[lang],
@@ -164998,6 +164999,10 @@ exports.AUTH0_TORUS_CONFIG_KEY = 'startrail-auth0-email-password';
 exports.COMPRESSION_ALGORITHM = 'gzip';
 exports.DEFAULT_WORD = {
     dappLogin: {
+        continueWith: {
+            ja: '前回の{verifier}アカウントを使う',
+            en: 'Continue with existing {verifier}'
+        },
         subtitle: {
             ja: 'でデジタルウォレット',
             en: 'Your digital wallet with'
@@ -165513,10 +165518,10 @@ class Service {
         };
         switch (config === null || config === void 0 ? void 0 : config.wallet) {
             case 'metamask':
-                this.wallet.start(new metamask_1.default(patchDeprecateParams(config)));
+                this.wallet.start(new metamask_1.default(Object.assign(Object.assign({}, patchDeprecateParams(config)), { wallet: 'metamask' })));
                 break;
             default:
-                this.wallet.start(new torus_1.default(patchDeprecateParams(config)));
+                this.wallet.start(new torus_1.default(Object.assign(Object.assign({}, patchDeprecateParams(config)), { wallet: 'startrail' })));
         }
         this.tx = new transaction_1.default((config === null || config === void 0 ? void 0 : config.apiPath) || constant_1.STARTRAIL_API);
     }
@@ -165760,6 +165765,35 @@ class Service {
             return res.data;
         });
     }
+    transferFromWithProvenance(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._validateEoaMatchFromInitialLogin();
+            const req = util_1.buildRequestObject(args);
+            const path = `/srr/${req.tokenId}/transferFromWithProvenance`;
+            const typedData = yield this.getMetaTxTypedData({ method: 'put', path: `${path}/typedData`, body: typedDataProps(req) });
+            const signature = yield this.signTypedDataMessage(typedData);
+            const res = yield this.tx.postTx(path, {
+                header: this._generateLuwHeader(req.header, signature, util_1.convertToUnpackNonce(typedData.message.nonce)),
+                body: req.body
+            });
+            return res.data;
+        });
+    }
+    bulk(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            this._validateEoaMatchFromInitialLogin();
+            // Todo: Add validation for each functionType ?
+            const path = '/srr/bulk';
+            const req = util_1.buildRequestObject(args);
+            const typedData = yield this.getMetaTxTypedData({ method: 'post', path: `${path}/typedData`, body: typedDataProps(req) });
+            const signature = yield this.signTypedDataMessage(typedData);
+            const res = yield this.tx.postTx(path, {
+                header: this._generateLuwHeader(req.header, signature, util_1.convertToUnpackNonce(typedData.message.nonce)),
+                body: req.body
+            });
+            return res.data;
+        });
+    }
     /**
      * Change language on your browser wallet
      * @throws Will throw an error
@@ -166045,6 +166079,43 @@ class Startrail {
             }
         });
     }
+    /**
+     * Transfer straight to EOA
+     * @throws Will throw an error
+     */
+    transferFromWithProvenance(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.store.torusStatus.popupInprogress)
+                return false;
+            this.store.switchPopupState();
+            try {
+                yield this.service.initAndLogin();
+                return yield this.service.transferFromWithProvenance(args);
+            }
+            finally {
+                this.store.switchPopupState();
+            }
+        });
+    }
+    /**
+     * Generic Bulk interface
+     * @todo Consolidate other bulk functions
+     * @throws Will throw an error
+     */
+    bulk(args) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (this.store.torusStatus.popupInprogress)
+                return false;
+            this.store.switchPopupState();
+            try {
+                yield this.service.initAndLogin();
+                return yield this.service.bulk(args);
+            }
+            finally {
+                this.store.switchPopupState();
+            }
+        });
+    }
     /**
      * Change language on your browser wallet
      * @throws Will throw an error
@@ -166305,6 +166376,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 const error_1 = __webpack_require__(/*! ./error */ "./src/error.ts");
 const constant_1 = __webpack_require__(/*! ./constant */ "./src/constant.ts");
+const ethers_1 = __webpack_require__(/*! ethers */ "./node_modules/ethers/lib.esm/index.js");
 class WalletBuilder {
     /**
    * To prevent creating duplicate wallets
@@ -166344,11 +166416,12 @@ class WalletBuilder {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.wallet === undefined)
                 throw new error_1.CustomError(Error(constant_1.StartrailSdkErrorCodeEnum.WALLET_NOT_INITIALIZED)).sdk();
-            const EOAs = yield this.wallet.login();
-            this.wallet.EOA = EOAs[0];
+            const rawEOAs = yield this.wallet.login();
+            const normalizedEOAs = rawEOAs.map((e) => ethers_1.utils.getAddress(e));
+            this.wallet.EOA = normalizedEOAs[0];
             if (!this.wallet.initialEOA)
-                this.wallet.initialEOA = EOAs[0];
-            return EOAs;
+                this.wallet.initialEOA = normalizedEOAs[0];
+            return normalizedEOAs;
         });
     }
     /**
@@ -166499,11 +166572,6 @@ class Wallet {
     overwriteConfig(partialConfig) {
         throw new error_1.CustomError(Error(constant_1.StartrailSdkErrorCodeEnum.WALLET_NOT_SUPPORT_FUNCTION)).sdk();
     }
-    getUserInfo() {
-        return __awaiter(this, void 0, void 0, function* () {
-            throw new error_1.CustomError(Error(constant_1.StartrailSdkErrorCodeEnum.WALLET_NOT_SUPPORT_FUNCTION)).sdk();
-        });
-    }
     switchLanguage() {
         return __awaiter(this, void 0, void 0, function* () {
             throw new error_1.CustomError(Error(constant_1.StartrailSdkErrorCodeEnum.WALLET_NOT_SUPPORT_FUNCTION)).sdk();
@@ -166581,6 +166649,19 @@ class Metamask extends base_1.default {
             }
         });
     }
+    getUserInfo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                email: '',
+                name: '',
+                profileImage: '',
+                verifier: '',
+                verifierId: '',
+                typeOfLogin: '',
+                wallet: 'metamask'
+            };
+        });
+    }
     signMessage(eoa, params) {
         const _super = Object.create(null, {
             signMessage: { get: () => super.signMessage }
@@ -166755,7 +166836,8 @@ class Torus extends base_1.default {
     getUserInfo() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                return yield this.torusSDK.getUserInfo('');
+                const res = yield this.torusSDK.getUserInfo('');
+                return Object.assign(Object.assign({}, res), { wallet: 'startrail' });
             }
             catch (e) {
                 throw new error_1.CustomError(e).torus();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@startbahn/startrail-sdk-js",
-  "version": "1.24.0-beta.3",
+  "version": "1.25.0-beta.2",
   "description": "Startrail Api for JS SDK",
   "main": "dist/startrail-sdk.js",
   "unpkg": "dist/startrail-sdk.js",

package/types/startrail-sdk-js.d.ts

@@ -78,6 +78,17 @@ declare module '@startbahn/startrail-sdk-js' {
         * @throws Will throw an error
         */
       addCustomHistoriesToSRRs(args: Type.AddCustomHistoriesToSRRs): Promise<Type.ResponseOfEthStateChange | false>;
+      /**
+        * Transfer straight to EOA
+        * @throws Will throw an error
+        */
+      transferFromWithProvenance(args: Type.TransferFromWithProvenance): Promise<Type.ResponseOfEthStateChange | false>;
+      /**
+        * Generic Bulk interface
+        * @todo Consolidate other bulk functions
+        * @throws Will throw an error
+        */
+      bulk(args: Type.Bulk): Promise<Type.ResponseOfEthStateChange | false>;
       /**
         * Change language on your browser wallet
         * @throws Will throw an error
@@ -119,6 +130,24 @@ declare module '@startbahn/startrail-sdk-js/types' {
       metadata: HistoryMetadata;
       hashFlag: boolean;
   }
+  export interface BulkCommon extends Pick<HTTPHeadersForStartrailLUW, 'startrailLUWContractAddress'> {
+      txs: {
+          functionType: BulkFunctionType.transferFromWithProvenance;
+          data: TransferFromWithProvenanceShared[];
+      };
+  }
+  export interface BulkTransferFromWithProvenance extends Pick<HTTPHeadersForStartrailLUW, 'startrailLUWContractAddress'> {
+      txs: TransferFromWithProvenanceShared[];
+  }
+  export enum BulkFunctionType {
+      createSRR = "createSRR",
+      approveSRRByCommitment = "approveSRRByCommitment",
+      transferFromWithProvenance = "transferFromWithProvenance"
+  }
+  interface CommonInit {
+      apiPath?: string;
+      env?: StartrailEnv;
+  }
   export interface ConvertMetadata {
       metadataBatch: {
           metadata: object;
@@ -143,6 +172,7 @@ declare module '@startbahn/startrail-sdk-js/types' {
           titleSignup: string;
       };
       modal?: {
+          continueLogin: string;
           termsConditions?: string;
           termsConditionsLinkUrl?: string;
       };
@@ -210,10 +240,8 @@ declare module '@startbahn/startrail-sdk-js/types' {
   }
   export type Language = 'ja' | 'en';
   export type LoginProvider = 'google' | 'email_password';
-  export interface MetamaskInit {
-      apiPath?: string;
-      wallet?: 'startrail' | 'metamask';
-      env?: StartrailEnv;
+  export interface MetamaskInit extends CommonInit {
+      wallet: 'metamask';
   }
   export enum MetaTxRequestType {
       WalletAddOwner = "WalletAddOwner",
@@ -285,11 +313,11 @@ declare module '@startbahn/startrail-sdk-js/types' {
   export interface DeprecateSDKInit {
       torusBuildEnv?: StartrailEnv;
   }
-  export type StartrailSDKInitConfig = StartrailInit & MetamaskInit & DeprecateSDKInit;
-  export interface StartrailInit {
-      apiPath?: string;
-      wallet?: 'startrail' | 'metamask';
-      env?: StartrailEnv;
+  export interface StartrailSDKInitConfig extends StartrailInit, DeprecateSDKInit {
+      wallet?: WalletType;
+  }
+  export interface StartrailInit extends CommonInit {
+      wallet?: WalletType;
       authAction?: AuthAction;
       auth0ClientId?: string;
       auth0Domain?: string;
@@ -308,6 +336,20 @@ declare module '@startbahn/startrail-sdk-js/types' {
   export interface TransferSRRBatch extends Pick<HTTPHeadersForStartrailLUW, 'startrailLUWContractAddress'> {
       txs: ApproveSRRByCommitmentShared[];
   }
+  export interface TransferFromWithProvenance extends TransferFromWithProvenanceShared, Pick<HTTPHeadersForStartrailLUW, 'startrailLUWContractAddress'> {
+  }
+  export interface Bulk extends Pick<HTTPHeadersForStartrailLUW, 'startrailLUWContractAddress'> {
+      txs: {
+          functionType: BulkFunctionType.transferFromWithProvenance;
+          data: TransferFromWithProvenanceShared;
+      }[];
+  }
+  export interface TransferFromWithProvenanceShared {
+      to: string;
+      tokenId: string;
+      metadata: HistoryMetadata;
+      isIntermediary?: boolean;
+  }
   export interface typedDataProps {
       fromAddress?: string;
       channelId?: string;
@@ -344,6 +386,7 @@ declare module '@startbahn/startrail-sdk-js/types' {
   export interface TorusStatus {
       popupInprogress: boolean;
   }
+  export type WalletType = 'startrail' | 'metamask';
   export type WalletLoginProvider = {
       google: boolean;
       emailPassword: boolean;
@@ -542,23 +585,23 @@ declare module '@startbahn/startrail-sdk-js/types' {
   }
   export interface UserInfo {
       /**
-        * Email of the logged in user
+        * Email of the logged in user if your selected wallets knows it
         */
       email: string;
       /**
-        * Full name of the logged in user
+        * Full name of the logged in user if your selected wallets knows it
         */
       name: string;
       /**
-        * Profile image of the logged in user
+        * Profile image of the logged in user if your selected wallets knows it
         */
       profileImage: string;
       /**
-        * verifier of the logged in user (google, facebook etc)
+        * verifier of the logged in user (google, facebook etc) if your selected wallets knows it
         */
       verifier: string;
       /**
-        * Verifier Id of the logged in user
+        * Verifier Id of the logged in user if your selected wallets knows it
         *
         * email for google,
         * id for facebook,
@@ -567,6 +610,8 @@ declare module '@startbahn/startrail-sdk-js/types' {
         * id for discord
         */
       verifierId: string;
+      typeOfLogin?: LoginProvider | '';
+      wallet?: WalletType;
   }
   interface VerifierStatus {
       google?: boolean;
@@ -660,6 +705,8 @@ declare module '@startbahn/startrail-sdk-js/service' {
         * @throws Will throw an error
         */
       addCustomHistoriesToSRRs(args: Type.AddCustomHistoriesToSRRs): Promise<Type.ResponseFromBatch>;
+      transferFromWithProvenance(args: Type.TransferFromWithProvenance): Promise<Type.ResponseOfEthStateChange | false>;
+      bulk(args: Type.Bulk): Promise<Type.ResponseOfEthStateChange | false>;
       /**
         * Change language on your browser wallet
         * @throws Will throw an error
@@ -850,6 +897,10 @@ declare module '@startbahn/startrail-sdk-js/constant' {
   export const COMPRESSION_ALGORITHM = "gzip";
   export const DEFAULT_WORD: {
     dappLogin: {
+      continueWith: {
+        ja: string;
+        en: string;
+      };
       subtitle: {
         ja: string;
         en: string;
@@ -983,11 +1034,11 @@ declare module '@startbahn/startrail-sdk-js/wallets/base' {
     constructor();
     abstract init(): Promise<void>;
     abstract login(): Promise<string[]>;
+    abstract getUserInfo(): Promise<UserInfo>;
     signMessage(eoa: string, params: object): Promise<string>;
     signTypedDataMessage(eoa: string, typedData: EIP712TypedData): Promise<string>;
     logout(): Promise<void>;
     overwriteConfig(partialConfig: OverwriteStartrailSDKConfig): void;
-    getUserInfo(): Promise<UserInfo>;
     switchLanguage(): Promise<void | boolean>;
   }
   export = Wallet;