@stellar/typescript-wallet-sdk 1.1.1 → 1.1.2

package/README.md

@@ -1,30 +1,44 @@
-# typescript-wallet-sdk
+# Stellar Typescript Wallet SDK [![npm version](https://badge.fury.io/js/@stellar%2Ftypescript-wallet-sdk.svg)](https://badge.fury.io/js/@stellar%2Ftypescript-wallet-sdk) 
 
-Typescript Wallet SDK to build Stellar wallets
+Typescript Wallet SDK is a library that allows developers to build wallet applications on the Stellar network faster. It
+utilizes [Javascript Stellar SDK](https://github.com/stellar/js-stellar-sdk) to communicate with a Stellar Horizon server.  
+It offers wide range of functionality to simplify integration with the Stellar network, and connect to the anchors easily, utilizing 
+various Stellar protocols (SEPs) 
 
-### This SDK is currently in development. Some features may not work as expected. Please use at your own risk.
+## Dependency
 
-### To use locally you can use npm link:
+The library is available via npm.
+To import `typescript-wallet-sdk` library you need to add it as a dependency to your code:
 
-```
-// build wallet sdk
-cd typescript-wallet-sdk
-yarn
-yarn run build
+yarn:
 
-// add npm link of sdk directory
-npm link
+```shell
+yarn add @stellar/typescript-wallet-sdk
+```
 
-// change to your wallet directory, and then create npm link
-cd my-wallet
-npm link @stellar/typescript-wallet-sdk
+npm:
 
-// import in wallet code
-import typescript-wallet-sdk from "@stellar/typescript-wallet-sdk"
+```shell
+npm install @stellar/typescript-wallet-sdk
 ```
 
-### To run tests:
+## Introduction
 
+Here's a small example creating main wallet class with default configuration connected to testnet network:
+
+```typescript
+let wallet = walletSdk.Wallet.TestNet();
 ```
-yarn test
+
+It should later be re-used across the code, as it has access to various useful children classes. For example, you can 
+authenticate with the `testanchor` as simple as:
+
+```typescript
+const authKey = SigningKeypair.fromSecret("my secret key");
+const anchor = wallet.anchor({ homeDomain: "testanchor.stellar.org" });
+const sep10 = await anchor.sep10();
+
+const authToken = await sep10.authenticate({accountKp: authKey});
 ```
+
+Read [full wallet guide](https://developers.stellar.org/docs/category/build-a-wallet) for more info

package/lib/bundle.js

@@ -18918,51 +18918,6 @@ function isEmpty(value) {
 module.exports = isEmpty;
 
 
-/***/ }),
-
-/***/ "./node_modules/lodash/isEqual.js":
-/*!****************************************!*\
-  !*** ./node_modules/lodash/isEqual.js ***!
-  \****************************************/
-/***/ ((module, __unused_webpack_exports, __webpack_require__) => {
-
-var baseIsEqual = __webpack_require__(/*! ./_baseIsEqual */ "./node_modules/lodash/_baseIsEqual.js");
-
-/**
- * Performs a deep comparison between two values to determine if they are
- * equivalent.
- *
- * **Note:** This method supports comparing arrays, array buffers, booleans,
- * date objects, error objects, maps, numbers, `Object` objects, regexes,
- * sets, strings, symbols, and typed arrays. `Object` objects are compared
- * by their own, not inherited, enumerable properties. Functions and DOM
- * nodes are compared by strict equality, i.e. `===`.
- *
- * @static
- * @memberOf _
- * @since 0.1.0
- * @category Lang
- * @param {*} value The value to compare.
- * @param {*} other The other value to compare.
- * @returns {boolean} Returns `true` if the values are equivalent, else `false`.
- * @example
- *
- * var object = { 'a': 1 };
- * var other = { 'a': 1 };
- *
- * _.isEqual(object, other);
- * // => true
- *
- * object === other;
- * // => false
- */
-function isEqual(value, other) {
-  return baseIsEqual(value, other);
-}
-
-module.exports = isEqual;
-
-
 /***/ }),
 
 /***/ "./node_modules/lodash/isFinite.js":
@@ -49115,12 +49070,8 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.Watcher = void 0;
-var isEqual_1 = __importDefault(__webpack_require__(/*! lodash/isEqual */ "./node_modules/lodash/isEqual.js"));
 var Types_1 = __webpack_require__(/*! ../Types */ "./src/walletSdk/Types/index.ts");
 // Do not create this object directly, use the Anchor class.
 var Watcher = /** @class */ (function () {
@@ -49209,9 +49160,9 @@ var Watcher = /** @class */ (function () {
                         }
                         return isInProgress;
                     }
-                    // if we've had the transaction before, only report updates
+                    // if we've had the transaction before, only report updates if status changed
                     if (registeredTransaction) {
-                        return !(0, isEqual_1.default)(registeredTransaction, transaction);
+                        return registeredTransaction.status !== transaction.status;
                     }
                     // if it's NOT a registered transaction, and it's not the first
                     // roll, maybe it's a new transaction that achieved a final
@@ -49323,10 +49274,11 @@ var Watcher = /** @class */ (function () {
                 return;
             }
             var registeredTransaction = _this._transactionsRegistry[assetCode][transaction.id];
-            // if we've had the transaction before, only report if there is a change
+            // if we've had the transaction before, only report if there is a status change
+            var isChanged = true;
             if (registeredTransaction &&
-                (0, isEqual_1.default)(registeredTransaction, transaction)) {
-                return;
+                registeredTransaction.status === transaction.status) {
+                isChanged = false;
             }
             _this._transactionsRegistry[assetCode][transaction.id] = transaction;
             if (transaction.status.indexOf("pending") === 0 ||
@@ -49337,7 +49289,9 @@ var Watcher = /** @class */ (function () {
                 _this._oneTransactionWatcher[assetCode][id] = setTimeout(function () {
                     _this.watchOneTransaction(__assign(__assign({}, allParams), { isRetry: true }));
                 }, timeout);
-                onMessage(transaction);
+                if (isChanged) {
+                    onMessage(transaction);
+                }
             }
             else if ([
                 Types_1.TransactionStatus.completed,
@@ -60223,7 +60177,7 @@ module.exports = JSON.parse('{"name":"stellar-sdk","version":"10.4.1","descripti
 /***/ ((module) => {
 
 "use strict";
-module.exports = JSON.parse('{"name":"@stellar/typescript-wallet-sdk","version":"1.1.1","engines":{"node":">=18"},"browser":"./lib/bundle_browser.js","main":"./lib/bundle.js","types":"./lib/index.d.ts","license":"Apache-2.0","private":false,"devDependencies":{"@babel/preset-env":"^7.20.2","@stellar/eslint-config":"^2.1.2","@stellar/prettier-config":"^1.0.1","@stellar/tsconfig":"^1.0.2","@types/jest":"^29.4.0","@types/lodash":"^4.14.194","@types/sinon":"^10.0.15","babel-jest":"^29.4.1","crypto-browserify":"^3.12.0","eslint":"^8.33.0","husky":"^8.0.0","jest":"^29.4.1","npm-run-all":"^4.1.5","prettier":"^2.0.5","pretty-quick":"^2.0.1","sinon":"^15.1.0","stream-browserify":"^3.0.0","ts-jest":"^29.0.5","ts-loader":"^9.4.2","tslib":"^2.5.0","typescript":"^5.0.4","webpack":"^5.83.1","webpack-cli":"^5.1.1"},"dependencies":{"axios":"^1.4.0","https-browserify":"^1.0.0","jws":"^4.0.0","lodash":"^4.17.21","query-string":"^7.1.3","stellar-sdk":"^10.4.1","stream-http":"^3.2.0","url":"^0.11.0","util":"^0.12.5","utility-types":"^3.10.0"},"scripts":{"prepare":"yarn build","test":"jest --watchAll","build:web":"webpack --config webpack.config.js","build:node":"webpack --env NODE=true --config webpack.config.js","build":"run-p build:web build:node"}}');
+module.exports = JSON.parse('{"name":"@stellar/typescript-wallet-sdk","version":"1.1.2","engines":{"node":">=18"},"browser":"./lib/bundle_browser.js","main":"./lib/bundle.js","types":"./lib/index.d.ts","license":"Apache-2.0","private":false,"devDependencies":{"@babel/preset-env":"^7.20.2","@stellar/eslint-config":"^2.1.2","@stellar/prettier-config":"^1.0.1","@stellar/tsconfig":"^1.0.2","@types/jest":"^29.4.0","@types/lodash":"^4.14.194","@types/sinon":"^10.0.15","babel-jest":"^29.4.1","crypto-browserify":"^3.12.0","eslint":"^8.33.0","husky":"^8.0.0","jest":"^29.4.1","npm-run-all":"^4.1.5","prettier":"^2.0.5","pretty-quick":"^2.0.1","sinon":"^15.1.0","stream-browserify":"^3.0.0","ts-jest":"^29.0.5","ts-loader":"^9.4.2","tslib":"^2.5.0","typescript":"^5.0.4","webpack":"^5.83.1","webpack-cli":"^5.1.1"},"dependencies":{"axios":"^1.4.0","https-browserify":"^1.0.0","jws":"^4.0.0","lodash":"^4.17.21","query-string":"^7.1.3","stellar-sdk":"^10.4.1","stream-http":"^3.2.0","url":"^0.11.0","util":"^0.12.5","utility-types":"^3.10.0"},"scripts":{"prepare":"yarn build","test":"jest --watchAll","build:web":"webpack --config webpack.config.js","build:node":"webpack --env NODE=true --config webpack.config.js","build":"run-p build:web build:node"}}');
 
 /***/ })