Update docs with information about SIWF SDKs and Troubleshooting (#815)

# Problem

Needed to update some docs

Part of frequency-chain/docs#123

# Solution
- @wilwade added docs around the SIWF SDK usage
- @mattheworris updated the Troubleshooting docs

## Screenshots (optional):

### SIWF SDK Docs (Main changed section)


![image](https://github.com/user-attachments/assets/8af315ee-f9e8-4662-8ab1-df8ac6769e70)

---------

Co-authored-by: Matthew Orris <[email protected]>

Author: wilwade

.spellcheckerdict.txt

@@ -113,6 +113,7 @@ S3-compatible
 scalable
 Schemas
 SDK
+SDKs
 signin
 signup
 SIWF

docs/src/GettingStarted/SSO.md

@@ -13,6 +13,7 @@ Key benefits:
 Resources:
 
 - [SIWF v2 Documentation](https://projectlibertylabs.github.io/siwf/v2/docs)
+- [SIWF v2 SDKs](https://projectlibertylabs.github.io/siwf/v2/docs/SDK/Overview.html)
 - [Account Service Documentation](../Build/AccountService/AccountService.md)
 
 ## Setup Tutorial
@@ -23,23 +24,23 @@ In this tutorial, you will set up a Sign In With Frequency button for use with T
 
 Before proceeding, ensure you have completed the following steps:
 
-**Registered as a Provider**  
+**Registered as a Provider**
 Register your application as a [Provider on Frequency Testnet](./BecomeProvider.md).
 
-**Completed the Access Form**  
+**Completed the Access Form**
 Fill out the [Frequency Access Testnet Account Setup form](https://docs.google.com/forms/d/e/1FAIpQLScN_aNMZpYqEdchSHrAR6MhKrVI1pA3SP6wxolAQCFckYoPOA/viewform).
 
-**Set Up a Backend Instance**  
+**Set Up a Backend Instance**
 You need a **backend-only-accessible** [running instance](../Run/GatewayServices/RunGatewayServices.md) of the Account Service.
 
-**Access to a Frequency RPC Node**  
+**Access to a Frequency RPC Node**
 
-- **Public Testnet Node:**  
+- **Public Testnet Node:**
 
   ```plaintext
   wss://0.rpc.testnet.amplica.io
   ```
-  
+
 ## Overview
 
 1. Application creates a signed request SIWF URL that contains a callback URL.
@@ -109,13 +110,30 @@ See list of [SIWF v2 Credentials](https://projectlibertylabs.github.io/siwf/v2/d
 
 ## Step 2: Forward the User for Authentication
 
+### Option A: SIWF Button SDK
+
+The SIWF SDK provides an easy way to use your `signedRequest` and display a button for your users.
+
+The example below is with the SIWF SDK for the Web.
+Guides for Android, iOS that also support handling the callback correctly and more are available [in the SIWF SDK documentation](https://projectlibertylabs.github.io/siwf/v2/docs/SDK/Overview.html).
+
+```html
+<!-- Add a button container with data attributes and replace "YOUR_ENCODED_SIGNED_REQUEST" with your "signedRequest" value -->
+<div data-siwf-button="YOUR_ENCODED_SIGNED_REQUEST" data-siwf-mode="primary" data-siwf-endpoint="mainnet"></div>
+<!-- Include the latest version of the script -->
+<script src="https://cdn.jsdelivr.net/npm/@projectlibertylabs/[email protected]/siwf-sdk-web.min.js"></script>
+```
+
+### Option B: Manually
+
 Redirect the user to the URL obtained from the previous step:
 
 ```javascript
 window.location.href = '"https://testnet.frequencyaccess.com/siwa/start?signedRequest=eyJyZXF1ZXN0ZWRTaWduYXR1cmVzIjp7InB1YmxpY0tleSI6eyJlbmNvZGVkVmFsdWUiOiJmNmNMNHdxMUhVTngxMVRjdmRBQk5mOVVOWFhveUg0N21WVXdUNTl0elNGUlc4eURIIiwiZW5jb2RpbmciOiJiYXNlNTgiLCJmb3JtYXQiOiJzczU4IiwidHlwZSI6IlNyMjU1MTkifSwic2lnbmF0dXJlIjp7ImFsZ28iOiJTUjI1NTE5IiwiZW5jb2RpbmciOiJiYXNlMTYiLCJlbmNvZGVkVmFsdWUiOiIweDNlMTdhYzM3Yzk3ZWE3M2E3YzM1ZjBjYTJkZTcxYmY3MmE5NjlkYjhiNjQyYzU3ZTI2N2Q4N2Q1OTA3ZGM4MzVmYTJjODI4MTdlODA2YTQ5NGIyY2E5Y2U5MjJmNDM1NDY4M2U4YzAxMzY5NTNlMGZlNWExODJkMzU0NjQ2Yzg4In0sInBheWxvYWQiOnsiY2FsbGJhY2siOiJodHRwOi8vbG9jYWxob3N0OjMwMDAiLCJwZXJtaXNzaW9ucyI6WzUsNyw4LDksMTBdfX0sInJlcXVlc3RlZENyZWRlbnRpYWxzIjpbeyJ0eXBlIjoiVmVyaWZpZWRHcmFwaEtleUNyZWRlbnRpYWwiLCJoYXNoIjpbImJjaXFtZHZteGQ1NHp2ZTVraWZ5Y2dzZHRvYWhzNWVjZjRoYWwydHMzZWV4a2dvY3ljNW9jYTJ5Il19LHsiYW55T2YiOlt7InR5cGUiOiJWZXJpZmllZEVtYWlsQWRkcmVzc0NyZWRlbnRpYWwiLCJoYXNoIjpbImJjaXFlNHFvY3poZnRpY2k0ZHpmdmZiZWw3Zm80aDRzcjVncmNvM29vdnd5azZ5NHluZjQ0dHNpIl19LHsidHlwZSI6IlZlcmlmaWVkUGhvbmVOdW1iZXJDcmVkZW50aWFsIiwiaGFzaCI6WyJiY2lxanNwbmJ3cGMzd2p4NGZld2NlazVkYXlzZGpwYmY1eGppbXo1d251NXVqN2UzdnUydXducSJdfV19XX0&mode=dark"';
 ```
 
 For mobile applications, use an embedded browser to handle the redirection smoothly with minimal impact on user experience.
+SDKs for [Android](https://projectlibertylabs.github.io/siwf/v2/docs/SDK/Android.html) and [iOS](https://projectlibertylabs.github.io/siwf/v2/docs/SDK/iOS.html) are available that handle this part for you.
 
 ## Step 3: Handle the Callback
 

docs/src/Troubleshooting.md

@@ -16,7 +16,7 @@ Provider registration is required to setup a Provider on Frequency. This is a on
 
 The Register User flow is the process by which a user registers with a Provider.  This is a one-time process required each time a user signs up with a new Provider.  The user will be able to log in to the Provider's app using the Sign In With Frequency [SIWF](https://github.com/ProjectLibertyLabs/siwf) process.  The user will now be able to interact with the Provider's app.
 
-The Login User flow is the process by which a user logs in to the Provider's app after the user has registered. The user will be able to interact with the Provider's app.
+The Login User flow is the process by which a user logs in to the Provider's app after the user has registered. The user will subsequently be able to interact with the Provider's app.
 
 <!-- This diagram is excerpted from the original here: [Account Service Flow Chart](https://github.com/ProjectLibertyLabs/gateway/blob/main/developer-docs/account/account-service-flow.md). Please keep these diagrams in sync.-->
 ```mermaid
@@ -229,7 +229,7 @@ VERBOSE [TxnNotifierService] Successfully found transaction 0xdefab4526e86f83aec
 
 Look in these logs for any errors or warnings. If you see any, they will give you a clue as to what went wrong.
 
-Use the block number to look up the transaction on the [Polkadot blockchain explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2F0.rpc.testnet.amplica.io#/explorer).
+Find the block number that corresponds with the error in the log, and then use that block number to look up the transaction on the [Polkadot blockchain explorer](https://polkadot.js.org/apps/?rpc=wss%3A%2F%2F0.rpc.testnet.amplica.io#/explorer).
 This will give you more information about the transaction and the error that occurred.
 
 <!-- {{#png-embed ./src/PolkadotBlockExplorer.png Polkadot Block Explorer}} -->
@@ -251,7 +251,25 @@ In the below example, the error index is 60 and the error code is 0. Error index
 
 ![Polkadot Block Explorer Error](./BlockchainError.png)
 
-### Other Debugging Tools
+### Validate Your Deployment
+
+Confirm that Frequency Developer Gateway Services are properly deployed and running. This guide provides examples for using [Docker Swarm](https://projectlibertylabs.github.io/gateway/Run/Deployment.html#part-1-deploying-with-docker-swarm) and [Kubernetes](https://projectlibertylabs.github.io/gateway/Run/Kubernetes.html) in AWS. However, the same principles apply to other deployment methods.
+
+#### Validate Your Services
+
+Gateway depends on a number of [standard services](https://projectlibertylabs.github.io/gateway/Fundamentals/Architecture.html?highlight=Redis#standard-services-gateway-uses) including Redis, BullMQ and IPFS Kubo API.  Each of these services must be correctly configured and deployed within your development environment in order for Gateway to function properly.  As part of this process, you may also wish to double check your [environment variables](https://github.com/ProjectLibertyLabs/gateway/blob/main/developer-docs/account/ENVIRONMENT.md).
+
+#### Validating Your IPFS Environment
+
+1. Ensure your [IPFS node](https://projectlibertylabs.github.io/gateway/Run/IPFS.html) is running correctly and check the status of your IPFS node.
+2. For additional management tasks and tests refer to the [IPFS Documentation](https://docs.ipfs.io).
+
+#### Validating Your Redis and BullMQ Environment
+
+1. Inspect all of your container logs, not just the ones pertaining to the API Service.  (Any one of your logs may show a problem with Redis.)  Look for error messages in your logs, specifically related to BullMQ or Redis.
+2. Try to execute a command shell in the container that your service is running in and invoke the Redis command line or ping the Redis node in order to verify your application container has network connectivity to your Redis environment.
+3. Further configuration information may be found in the [environment files](https://github.com/ProjectLibertyLabs/gateway/blob/main/env-files/account.template.env#L36).
+4. If either of these tests fail, you will need to first correct the problems in the Redis environment before you can move forward with Gateway.
 
 #### Swagger/OpenAPI Documentation
 

libs/cache/src/cache.config.spec.ts

@@ -59,7 +59,7 @@ describe('Cache module config', () => {
       const options = {
         host: 'localhost',
         port: 6379,
-        commandTimeout: 10000,
+        commandTimeout: 25000,
       };
       expect(cacheConf.redisOptions).toStrictEqual(options);
     });
@@ -76,7 +76,7 @@ describe('Cache module config', () => {
         keepAliveTimeout: 300,
       };
       const cacheConf = await setupConfigService({ ...optionsEnv, REDIS_OPTIONS: JSON.stringify(options) });
-      expect(cacheConf.redisOptions).toStrictEqual({ ...options, commandTimeout: 10000 });
+      expect(cacheConf.redisOptions).toStrictEqual({ ...options, commandTimeout: 25000 });
     });
 
     it('should get redis options with overriden defaults', async () => {

tools/ci-k6/main.mjs

@@ -44,7 +44,7 @@ export async function createAndStake(providerUrl, keyUri) {
     api.tx.capacity.stake(1, 10_000_000_000_000),
     // Need to create an 'OnChain' schema in order to test endpoints, as there are no registered 'OnChain' DSNP schemas
     // **SHOULD** get created as SchemaID 16001
-    api.tx.schemas.createSchema(JSON.stringify(AVRO_GRAPH_CHANGE), 'AvroBinary', 'OnChain'),
+    api.tx.schemas.createSchemaV3(JSON.stringify(AVRO_GRAPH_CHANGE), 'AvroBinary', 'OnChain', [], 'test.graphchange'),
   ]);
 
   console.log('Submitting call...');
@@ -61,7 +61,9 @@ export async function createAndStake(providerUrl, keyUri) {
           );
         const success = events.find((x) => api.events.system.ExtrinsicSuccess.is(x.event));
         const failure = events.find((x) => api.events.system.ExtrinsicFailed.is(x.event));
-        const { event: schemaCreated } = events.find((x) => api.events.schemas.SchemaCreated.is(x.event));
+        const { event: schemaCreated } = success
+          ? events.find((x) => api.events.schemas.SchemaCreated.is(x.event))
+          : { event: null };
         unsub();
         if (schemaCreated) {
           console.log(`Created OnChain schema ID ${schemaCreated.data.schemaId.toNumber()}`);
@@ -70,7 +72,7 @@ export async function createAndStake(providerUrl, keyUri) {
           console.log('Success!');
           resolve();
         } else {
-          console.error('FAILED!');
+          console.error('FAILED!', failure.toHuman());
           reject();
         }
       }