feat!: Switch to SIP-030 (#403)

* chore: partial

* chore: partial

* chore: add more partial, all methods

* chore: partial compiling

* chore: add more backwards comp, compiles

* chore: update error handling and option casting

* chore: add xverse overrides

* fix: add missing AppConfig export

* fix: remove stacks/auth remnants

* fix: update xverse strictness

* fix: make auth options less strict

* chore: update imports

* chore: add temporary eslint ignore line

* fix: update usersession disconnect behavior

* fix: address pr feedback

* fix!: rename persistselection property

* refactor: improve error handling

* chore: rename to uppercase

* refactor: simplify object returns

* docs: update changelog

* docs: update readme

* docs: add provider push

* docs: add identity check

* fix: update authenticate provider handling

* chore: remove import

* fix: auto encode and decode base64 for psbt

* fix: update caps for sighash

* fix: add fordefi default provider

* test: update storybook test dapp

* fix: add fordefi to override list

* fix: update clarity values parsing

* chore: add bigint tojson

* ci: add beta deploy

* fix: add btcAddress to legacy profile

* test: fix demo app

* chore: update lerna

* chore: add optional to package lock

* chore: update lock based on file on main

* chore: add literal union

* fix: remove jsontokens dependency

* fix: update error types and allow error in onCancel

* fix: update overrides

* fix: update param serialization

* docs: add new request docs

* test: fix story app

---------

Co-authored-by: janniks <[email protected]>

Author: janniks

.changeset/bright-pumpkins-speak.md

@@ -0,0 +1,17 @@
+---
+'@stacks/connect-react': major
+'@stacks/connect': major
+---
+
+Switch to new RPC API with SIP-030
+
+BREAKING CHANGE:
+
+Adds the new `request` method to the `@stacks/connect` package.
+Which is the default way of interacting with Bitcoin and Stacks wallets.
+This update needs a slightly breaking change to the `showXyz` and `openXyz` methods.
+
+- ADDED `request` (UI) and `requestRaw` for calling wallet RPC methods
+- UPDATED `SessionData` and `UserSession` to only expose a light `UserData` with `profile.stxAddress`
+- UPDATED `StacksProvider` to only have a `request` method
+- REMOVED `BlockstackProvider`, `StacksProvider`

.changeset/lovely-jobs-fail.md

@@ -0,0 +1,10 @@
+---
+'@stacks/connect-ui': major
+---
+
+Update UI properties
+
+BREAKING CHANGE:
+
+- RENAMED `persistSelection` to `persistWalletSelect`
+- REMOVED `shouldUsePopup` from `@stacks/connect-ui`

.github/workflows/pull_request.yml

@@ -67,27 +67,30 @@ jobs:
       - name: Get git commit
         id: git-commit
         run: echo "::set-output name=sha::$(git rev-parse --short HEAD)"
-      - name: print preid
-        env:
-          BRANCH: ${{ steps.git-branch.outputs.branch }}
-          SHA: ${{ steps.git-commit.outputs.sha }}
-        run: echo $BRANCH.$SHA
+      - name: Set preid
+        id: preid
+        run: |
+          if [ "${{ steps.git-branch.outputs.branch }}" = "beta" ]; then
+            echo "preid=beta" >> "$GITHUB_OUTPUT"
+          else
+            echo "preid=alpha.${{ steps.git-commit.outputs.sha }}" >> "$GITHUB_OUTPUT"
+          fi
       - name: Setup git
         run: |
           git config --local user.email "[email protected]"
           git config --local user.name "GitHub Action"
       - name: Publish to NPM
         env:
           BRANCH: ${{ steps.git-branch.outputs.branch }}
-          SHA: ${{ steps.git-commit.outputs.sha }}
-        run: npx lerna publish prepatch --preid alpha.$SHA --dist-tag $BRANCH --yes --no-push
-      - name: Get alpha package versions
-        id: alpha
+          PREID: ${{ steps.preid.outputs.preid }}
+        run: npx lerna publish prepatch --preid $PREID --dist-tag $BRANCH --yes --no-push
+      - name: Get package versions
+        id: versions
         run: |
           echo "connect=$(cat packages/connect/package.json | jq -r '.version')" >> "$GITHUB_OUTPUT"
           echo "connectreact=$(cat packages/connect-react/package.json | jq -r '.version')" >> "$GITHUB_OUTPUT"
           echo "connectui=$(cat packages/connect-ui/package.json | jq -r '.version')" >> "$GITHUB_OUTPUT"
       - uses: janniks/[email protected]
         with:
-          header: "> This PR was published to npm with the alpha versions:\n> - connect `npm install @stacks/connect@${{ steps.alpha.outputs.connect }} --save-exact`\n> - connect-react `npm install @stacks/connect-react@${{ steps.alpha.outputs.connectreact }} --save-exact`\n> - connect-ui `npm install @stacks/connect-ui@${{ steps.alpha.outputs.connectui }} --save-exact`"
+          header: "> This PR was published to npm with versions:\n> - connect `npm install @stacks/connect@${{ steps.versions.outputs.connect }} --save-exact`\n> - connect-react `npm install @stacks/connect-react@${{ steps.versions.outputs.connectreact }} --save-exact`\n> - connect-ui `npm install @stacks/connect-ui@${{ steps.versions.outputs.connectui }} --save-exact`"
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -20,25 +20,75 @@ This repository includes three packages:
 - [`@stacks/connect-react`](./packages/connect-react): A wrapper library for making `@stacks/connect` use in React even easier
 - [`@stacks/connect-ui`](./packages/connect-ui): A web-component UI for displaying an intro modal in Stacks web-apps during authentication _(used in the background by `@stacks/connect`)_.
 
-## 🌎 More Information
-
-The [Stacks documentation website](https://docs.stacks.co/build-apps/overview) includes more examples for building apps using Connect.
-
-It also includes guides for various aspects of Stacks application development:
-
-- [Authentication](https://docs.stacks.co/build-apps/references/authentication)
-- [Transactions](https://docs.stacks.co/understand-stacks/technical-specs#transactions)
-- [Data storage](https://docs.stacks.co/build-apps/references/gaia#understand-data-storage)
-
-## 🐛 Bugs and feature requests
-
-If you encounter a bug or have a feature request, we encourage you to follow the steps below:
-
-1.  **Search for existing issues:** Before submitting a new issue, please search [existing and closed issues](https://github.com/hirosystems/connect/issues) to check if a similar problem or feature request has already been reported.
-1.  **Open a new issue:** If it hasn't been addressed, please [open a new issue](https://github.com/hirosystems/connect/issues/new/choose). Choose the appropriate issue template and provide as much detail as possible, including steps to reproduce the bug or a clear description of the requested feature.
-1.  **Evaluation SLA:** Our team reads and evaluates all the issues and pull requests. We are avaliable Monday to Friday and we make a best effort to respond within 7 business days.
-
-Please **do not** use the issue tracker for personal support requests or to ask for the status of a transaction. You'll find help at the [#stacks-js Discord channel](https://stacks.chat/).
+## 🛠️ Wallet Implementation Guide
+
+Wallets implement a "Provider" interface.
+The latest spec uses a simple JS Object exposing a `.request(method: string, params?: object)` method.
+
+Pseudo-code:
+
+```ts
+window.MyProvider = {
+  async request(method, params) {
+    // Somehow communicate with the wallet (e.g. via events)
+
+    // Recommendation: Create a JSON RPC 2.0 request object
+    // https://www.jsonrpc.org/specification
+
+    return Promise.resolve({
+      // Respond with a JSON RPC 2.0 response object
+      id: crypto.randomUUID(), // required, same as request
+      jsonrpc: '2.0', // required
+
+      // `.result` is required on success
+      result: {
+        // object matching specified RPC methods
+      },
+
+      // `.error` is required on error
+      error: {
+        // Use existing codes from https://www.jsonrpc.org/specification#error_object
+        code: number, // required, integer
+        message: string, // recommended, single sentence
+        data: object, // optional
+      },
+    });
+  },
+  isMyWallet: true, // optional, a way of identifying the wallet for developers
+};
+
+window.wbip_providers = window.wbip_providers || [];
+window.wbip_providers.push({
+  // `WbipProvider` type
+    /** The global "path" of the provider (e.g. `"MyProvider"` if registered at `window.MyProvider`) */
+  id: 'MyProvider',
+  /** The name of the provider, as displayed to the user */
+  name: 'My Wallet';
+  /** The data URL of an image to show (e.g. `data:image/png;base64,iVBORw0...`) @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs */
+  icon?: 'data:image/png;base64,iVBORw0...';
+  /** Web URL of the provider */
+  webUrl?: 'https://mywallet.example.com';
+
+  // Addional URLs
+  chromeWebStoreUrl?: string;
+  mozillaAddOnsUrl?: string;
+  googlePlayStoreUrl?: string;
+  iOSAppStoreUrl?: string;
+});
+```
+
+### JSON RPC 2.0
+
+Wallets may add their own unstandardized methods.
+However, the minimum recommended methods are:
+
+- `getAddresses` [WBIP](https://wbips.netlify.app/request_api/getAddresses)
+- `signPsbt` [WBIP](https://wbips.netlify.app/request_api/signPsbt)
+- `stx_getAddresses` [SIP-030](https://github.com/janniks/sips/blob/main/sips/sip-030/sip-030-wallet-interface.md)
+- `stx_transferStx` [SIP-030](https://github.com/janniks/sips/blob/main/sips/sip-030/sip-030-wallet-interface.md)
+- `stx_callContract` [SIP-030](https://github.com/janniks/sips/blob/main/sips/sip-030/sip-030-wallet-interface.md)
+- `stx_signMessage` [SIP-030](https://github.com/janniks/sips/blob/main/sips/sip-030/sip-030-wallet-interface.md)
+- `stx_signStructuredMessage` [SIP-030](https://github.com/janniks/sips/blob/main/sips/sip-030/sip-030-wallet-interface.md)
 
 ## 🎁 Contribute
 
@@ -59,3 +109,14 @@ Join our community and stay connected with the latest updates and discussions:
 - [Join our Discord community chat](https://stacks.chat/) to engage with other users, ask questions, and participate in discussions.
 - [Visit hiro.so](https://www.hiro.so/) for updates and subcribing to the mailing list.
 - Follow [Hiro on Twitter.](https://twitter.com/hirosystems)
+
+### MIGRATION TODO
+
+#### TODO
+
+- Add `PostConditionModeName` to all options (new and old) — This might have been missing since the v7 release.
+- Strip unserializable fields from RawLegacy wrapper just in case.
+- Remove exports from LEGACY_XYZ
+- Make hex to base64 for psbt
+
+Search for the below and replace with inline return.