Merge pull request #415 from PureStake/master

Patch 1.9.1
PureStake · Jun 22, 2022 · 6f2ec55 · 6f2ec55
2 parents ae81eea + fb7d9c7
commit 6f2ec55
Show file tree

Hide file tree

Showing 38 changed files with 635 additions and 562 deletions.
diff --git a/README.md b/README.md
@@ -10,48 +10,38 @@ _This is the preferred solution for end-users, updates will be automatically ins
 
 Developers working with dApps may also install directly from the release package, or by downloading the project and building it.
 
-# `AlgoSigner.sign()` and `AlgoSigner.signMultisig()` have been officially deprecated.
+## `AlgoSigner.sign()` and `AlgoSigner.signMultisig()` have been officially deprecated.
 
-## 1.9.0 Release
+An interactive transition guide is available [here](https://purestake.github.io/algosigner-dapp-example/v1v2TransitionGuide.html).
+
+## 1.9.1 Release
 
 ### Main updates
-This update adds supports for easier transfers with the new autocomplete feature. Start typing an account or contact name on the destination field when sending Algos or ASAs and you'll be able to select the desired address from a dropdown. This also marks the end of the support of the older signing methods that were previously available.
-- Autocomplete support for UI-made transfers
-- `AlgoSigner.sign()` and `AlgoSigner.signMultisig()` have been deprecated
+This update adds supports for easier transfers with the new autocomplete feature. Start typing an account, contact name or name service alias on the destination field when sending Algos or ASAs and you'll be able to select the desired address from a dropdown. This also marks the end of the support of the older signing methods that were previously available.
 
+- Autocomplete feature for UI-made transfers, supporting:
+  - Accounts and Contact names
+  - External name services (NFDomains and Algorand Namespace Service)
+- `AlgoSigner.sign()` and `AlgoSigner.signMultisig()` have been deprecated
 
 ## New Users
 
 - Watch [Getting Started with AlgoSigner](https://youtu.be/tG-xzG8r770)
-- [Ledger Readme](docs/ledger.md)
-
-## Adding Custom Networks
-
-AlgoSigner users may add their own networks to the extension, for example BetaNet or the sandbox private network - [Instructions](docs/add-network.md)
+- [Using a Ledger device](docs/ledger.md)
+- [Adding Custom Networks](docs/add-network.md) (such as BetaNet or a private network)
+- [Troubleshooting Connection issues](docs/connection-issues.md)
 
 ## dApp Developers
 
 For teams looking to integrate AlgoSigner into a project:
 
-Developing with v2 Transaction Signing
-
-- [dApp development guide](docs/dApp-guide.md)
-- [v2 AlgoSigner methods](docs/dApp-integration.md)
-
-Legacy v1 Transaction Signing is going to be deprecated soon and is available only for reference purposes.
-Please use v2 when developing new apps and migrate existing apps that are still using v1 to v2 as soon as possible.
-
-- [v1 Guide](docs/legacy-signing.md)
-- [v1 AlgoSigner methods](docs/legacy-dApp-integration.md)
-
-## Roadmap
-
-- UI improvements
-- Contribution guidelines
+- [dApp Development guide](docs/dApp-guide.md)
+- [AlgoSigner dApp Integration Guide](docs/dApp-integration.md)
 
-### AlgoSigner development
+## AlgoSigner development
 
-For developers interested in working with AlgoSigner [Extension Guide](docs/extension-developers.md). A contribution guide is in development.
+For developers interested in working with AlgoSigner, an [Extension Development Guide](docs/extension-developers.md) is available.
+Pull requests we accept need to be narrow in scope and all contributors need to sign (once) our [CLA](https://github.com/PureStake/algosigner-cla/blob/main/CLA.md) after submitting one in order for it to be considered.
 
 ## License
 

diff --git a/docs/connection-issues.md b/docs/connection-issues.md
@@ -0,0 +1,36 @@
+# AlgoSigner Connection Issues
+
+If you're having issues accessing a dApp using AlgoSigner, you can try the following steps in order to delete any old existing connection that you may have lingering on the browser/website.
+
+## Connection Troubleshooting
+
+Find and press any disconnect button present on the dApp.
+
+<img src="./connection_images/disconnect.png" width="300" />
+<br />
+<br />
+
+Open the config menu and log out of AlgoSigner.
+
+<img src="./connection_images/open-config.png" height="400" />
+<img src="./connection_images/logout.png" height="400" />
+<br />
+<br />
+
+Reload the tab/window where the dApp is open and attempt to connect again.
+
+<img src="./connection_images/reload.png" height="80" />
+<img src="./connection_images/connect.png" height="80" />
+
+<br />
+<hr />
+<br />
+
+## Additional steps
+
+If the issue persists, try deleting your local browser cache and cookies before attempting to connect to the dApp again.
+
+[Steps for Chrome](https://support.google.com/accounts/answer/32050)
+
+[Steps for Brave](https://support.brave.com/hc/en-us/articles/360048833872-How-Do-I-Clear-Cookies-And-Site-Data-In-Brave-)
+
diff --git a/docs/connection_images/connect.png b/docs/connection_images/connect.png
diff --git a/docs/connection_images/disconnect.png b/docs/connection_images/disconnect.png
diff --git a/docs/connection_images/logout.png b/docs/connection_images/logout.png
diff --git a/docs/connection_images/open-config.png b/docs/connection_images/open-config.png
diff --git a/docs/connection_images/reload.png b/docs/connection_images/reload.png
diff --git a/docs/dApp-guide.md b/docs/dApp-guide.md
@@ -10,13 +10,9 @@ DApp users can trust AlgoSigner to:
 - Authorize transactions without giving dApps direct access to their keys
 - Sign and approve transactions when using dApps
 
-## v2 Signing
+## Signing transactions with AlgoSigner
 
-With the release of v2 signing, developers coding to the standard will be able to use the same code with any Algorand Wallet.
+You can start by looking at examples of how to sign transactions with AlgoSigner in the [example dapp](https://purestake.github.io/algosigner-dapp-example/index.html).
 
-- Examples of signing with v2 are available in the [dapp examples repo](https://purestake.github.io/algosigner-dapp-example/index.html).
-- An interactive transition guide that demonstrates the differences between v1 and v2 signing is available as a link from the dapp examples repo or directly access the [transition guide](https://purestake.github.io/algosigner-dapp-example/v1v2TransitionGuide.html).
+Also available to read is our [dApp integration guide](dApp-integration.md).
 
-### Developing a dApp
-
-- Read [v2 dApp Integration Guide](dApp-integration.md)
diff --git a/docs/dApp-integration.md b/docs/dApp-integration.md
@@ -4,8 +4,6 @@
 
 AlgoSigner injects a JavaScript library into every web page the browser user visits, which allows the site to interact with the extension. The dApp can use the injected library to connect to the user's Wallet, discover account addresses it holds, query the Network (make calls to AlgoD v2 or the Indexer) and request AlgoSigner to request for the user to sign a transaction initiated by the application. **All methods of the injected library return a Promise that needs to be handled by the dApp.**
 
-This guide covers the new v2 Transactions Signing method, docs for the legacy v1 signing are [here](legacy-dApp-integration.md)
-
 ## Methods
 
 - [AlgoSigner.connect()](#algosignerconnect)

diff --git a/docs/extension-developers.md b/docs/extension-developers.md
@@ -10,21 +10,20 @@ There are multiple packages in the project that combine to build the overall ext
 
 *https://github.com/PureStake*
 
-- algosigner-> // Base project folder
-  - dist-> // Folder containing the combined distribution components, used to install the extension, created on build
-  - packages-> // Folder for scripts components that support the extension
-    - common-> // Contains core elements used in other packages
-      - crypto-> // Wrapper for encrypting and decrypting account information
-      - dapp-> // AlgoSigner library that gets injected in dApps
-      - extension-> // Extension definition and core files
+- algosigner -> // Base project folder
+  - dist -> // Folder containing the combined distribution components, used to install the extension, created on build
+  - packages -> // Folder for scripts components that support the extension
+    - common -> // Contains core elements used in other packages
+    - crypto -> // Wrapper for encrypting and decrypting account information
+    - dapp -> // AlgoSigner library that gets injected in dApps
+    - extension -> // Extension definition and core files
     - storage -> // Handles saving and loading of account information
     - test-project -> // Test wrapper for the package files
-      - ui-> // Front end application for interaction within the extension interface
+    - ui -> // Front end application for interaction within the extension interface
   - manifest.json // Extension definition file
-  - package.json // Algosigner package, required packages, and scripts to build the project
+  - package.json // AlgoSigner package, required packages, and scripts to build the project
   - readme.md // Project overview
   - docs -> // Guides and how-to's
-    - dApp-integration.md // Guide to integrating dApps with AlgoSigner
   - media -> // Supporting images for this repository
   - LICENSE.txt // License for this repository