SIWF v2 Reference App

[shannonwells]

Problem

We need to adequately show developers how to use SIWF v2, allow them to check their implemetation for correctness, build good tests, and suchlike.

Write a reference app that demonstrates how to use siwf v2 (only, not v1).

Acceptance Criteria

Payloads can use pre-configured input such as MSAs, domains and handles for the first version.

Part I

• a Design Document. For guidance on this format, see frequency-chain designdocs

Part II, implementation.

It should demonstrate how to:

• build and sign all possible payload content and generate request and response data
• connect to window.ethereum -what Metamask uses. See EIP-1193
• connect to polkadot-compatible wallets such as Subwallet and Talisman ,
• enable users to sign payloads:
  • creating secp256k1 signatures (using EIP-712 payload)
  • creating sr25519 signatures (using SCALE-encoded payloads).
• The resulting payload should be pastable into an RPC call or for testing, assuming any other prerequisites are met (the MSA exists, the delegations exist, the provider exists, etc).
• The reference app should work with Social App Template if SAT is configured to use it instead of Frequency Access.

Part III Bonus work, possibly for a second version:

• The payloads and signatures it produces should be able to be pasted into Gateway's Swagger API endpoints and succeed, assuming any prerequisites are met
• The payloads should be configurable through a form that shows the user-settable fields such as MSA, handle, and address.
• There should be a generic payload signing tool that will submit a payload to the chosen wallet using the correct payload type.
• Support for EIP-6963

For guidance, look at connect embedded-wallet-sdk, especially the startSiwf function, but it does more than is needed for a reference app, like connecting to gateway.

[shannonwells]

@ProjectLibertyLabs/gateway-developer

[emresurmeli]

Current completion of requirements:

Requirement	Status
EIP-1193 (MetaMask)	Done
EIP-712 Signatures	Done
SIWF Requests	Done
Polkadot Connection	Partial
sr25519 + SCALE	Still WIP
RPC Compatibility	Currently using the SDK to make RPC calls
SAT Integration	Needs to be implemented
Full Payload Support	Needs to be implemented

I would also add the following requirement to make it more presentable:

Requirement	Status
Frequency Theme, logo, etc	Missing

At this stage, we have a SIWF v2 mock implementation that is useful to a dev trying to implement SIWF v2. Polkadot.js wallet integration is mocking, Worth a review at its current status.