Sign a tx from link opened via CLI #987

elizabethengelman · 2024-08-27T16:42:29Z

closes #928

This PR is now using an approach that CLI can send a req to a url with the query params networkPassphrase and xdr, and expect lab to parse those args. This was so that the CLI sign_with_lab functionality could remain generic, and not be tied to Lab's implementation.

To test, without using the CLI, go to the URL that the CLI produces:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/transaction/cli-sign?networkPassphrase=Test+SDF+Network+%3B+September+2015&xdr=AAAAAgAAAADcOHnq5sGLOngOCEMyLqqn5CvFV2HGbOSjJAIzhqBdkAAAAGQAEb7UAAAAAQAAAAAAAAAAAAAAAQAAAAAAAAAYAAAAAQAAAAAAAAAAAAAAANw4eermwYs6eA4IQzIuqqfkK8VXYcZs5KMkAjOGoF2Q04SY%2FPMseMCgfbEFkX5gTr9qD%2Fd0mvD9H3acFOz%2FX5oAAAAALtGgcgsAibk5q8VOLY2R1G1NdGX7fLzlz7iBFBy64JIAAAAAAAAAAAAAAAA%3D

old notes:
This is a work in progress that I'd love some eyes on to help me think through the approach. For now I am just focusing on allowing the CLI to open Lab with the tx XDR already imported, and ready to sign.

To sign a tx on the CLI side, we have easy access to the rpc-url and the network-password.

To sign a tx in Lab, we need a Network object:

 Network = {
    id: NetworkType;
    label: string;
    horizonUrl: string;
    rpcUrl: string;
    passphrase: string;
}

Instead of adding additional network information to CLI, my current approach is to pass the tx xdr, and the configured network_passphrase from the CLI to Lab via query string params. We should be able to look up the Network by the passphrase based on the NetworkOptions.
I first tried to just pass the network passphrase in the query string like this: http://localhost:3000/transaction/sign?$=network$passphrase=Test SDF Network /; September 2015;&transaction$sign$activeView=overview&importXdr=AAAAAgAAAAC...=;;
But, if we don’t pass the network id in the /transaction/sign query string, Lab will use a default network that is not necessarily the one that the user configured with their CLI command. This behavior makes sense to me, but I wasn’t sure of the best way to get around the auto network selection, and instead use the network passphrases passed in to lookup which network to use.
- The network selector functionality happens before we get to the transaction/sign page. So by the time we get to the sign tx page, the query string & store have been updated to include the newly chosen network. So we no longer have the network passphrase information the user sent from the CLI to look up the correct network.
- example
  - when we visit /transaction/sign?$=network$passphrase=Test SDF Network /; September 2015;&transaction$sign$activeView=overview&importXdr=AAAAAgAAAAC...=;;
  - the network selector will update it to /transaction/sign?$=network$id=futurenet&label=Futurenet&horizonUrl=https:////horizon-futurenet.stellar.org&rpcUrl=https:////rpc-futurenet.stellar.org&passphrase=Test%20SDF%20Future%20Network%20/;%20October%202022;&transaction$sign$activeView=overview&importXdr=AAAAAgAAAAC...0=;;
A couple ideas I had to get around this:
- Figure out what that assumed network id should be in the CLI, based on the network passphrase the user has configured and pass that along in the Lab request query string. But I wonder if it makes sense to do this in Lab instead since we already have the full network settings to do the look up in NetworkOptions
- Add another query param when sending the request to /transaction/sign that wouldn’t get overwritten in the NetworkSelector, but this felt like it wasn’t the right call. We already have the info we need.
- Have an intermediary page /transaction/cli-sign that has a manual Network selector, and then redirects to `/transaction/sign.

The last option is what I am currently doing in this PR, though it doesn't seem ideal. Curious if anyone has any thoughts on how to handle this. I haven't used zustand-querystring before, so I may be missing some option with that lib to handle this better.

Sidenote: I also noticed that some of the weird URL escaping that zustand-querystring may be fixed in more recent release, but that seems like something we can address in follow up PRs.

stellar-jenkins · 2024-08-27T16:47:29Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

stellar-jenkins · 2024-08-28T20:48:44Z

Something went wrong with PR preview build please check

stellar-jenkins · 2024-08-29T16:32:49Z

Something went wrong with PR preview build please check

stellar-jenkins · 2024-08-29T21:19:37Z

Something went wrong with PR preview build please check

stellar-jenkins · 2024-08-30T14:22:21Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

elizabethengelman · 2024-09-03T18:24:13Z

src/components/NetworkByPasswordProvider.tsx

+import { useEffect } from "react";
+
+// Component to set Network and Xdr if only password is given in query string
+export const NetworkByPasswordProvider = ({


I'd love some feedback/other ideas on the name of this component.

stellar-jenkins · 2024-09-03T18:31:03Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

stellar-jenkins · 2024-09-03T18:32:37Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

stellar-jenkins · 2024-09-04T16:51:21Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

stellar-jenkins · 2024-09-04T18:17:41Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

quietbits · 2024-09-04T19:39:12Z

src/app/layout.tsx

+import { NetworkByPasswordProvider } from "@/components/NetworkByPasswordProvider";
 import "@/styles/globals.scss";
+import "@stellar/design-system/build/styles.min.css";


Let's keep the Design System import before the global.css to make sure the global overrides work.

quietbits · 2024-09-04T19:43:52Z

src/app/(sidebar)/transaction/cli-sign/page.tsx

+"use client";
+
+import { Routes } from "@/constants/routes";
+import { useStore } from "@/store/useStore";
+import { Loader } from "@stellar/design-system";
+import { useRouter } from "next/navigation";
+import { useEffect } from "react";
+
+export default function CliSignTransaction() {
+  const { network, transaction } = useStore();
+  const { sign } = transaction;
+  const router = useRouter();
+  useEffect(() => {
+    router.push(Routes.SIGN_TRANSACTION);
+  }, [sign.importXdr, network, router]);
+
+  return <Loader />;
+}


I like this idea of using the route to do the redirect. 🙌 Do you think we could move NetworkByPasswordProvider logic here and remove it completely from src/app/layout.tsx. That way, everything related to CLI sign transaction would be handled in one place.

Ah, great idea! I'll get an update pushed shortly

stellar-jenkins · 2024-09-06T16:26:50Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

stellar-jenkins · 2024-09-06T16:49:34Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

Ifropc · 2024-09-06T20:49:22Z

Functionally and code-vise LGTM!

src/app/(sidebar)/transaction/cli-sign/page.tsx

quietbits · 2024-09-09T12:41:47Z

src/app/(sidebar)/transaction/cli-sign/page.tsx

+    }
+
+    router.push(Routes.SIGN_TRANSACTION);
+  }, [sign.importXdr, network, router, searchParams, updateIsDynamicNetworkSelect, selectNetwork, transaction]);


Normally, we shouldn't use objects as dependencies (network, searchParams, transaction, for example) because they will trigger unwanted re-renders (use strings and numbers instead). It might not matter much in this case because users won't stay on this component for long, though.

Good call! I think my IDE was being a little too generous with the deps... I'll update this shortly.

Co-authored-by: Iveta <quietbits@users.noreply.github.com>

stellar-jenkins · 2024-09-10T17:13:41Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

stellar-jenkins · 2024-09-10T17:14:06Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

stellar-jenkins · 2024-09-10T18:00:28Z

Preview is available here:
http://laboratory-pr987.previews.kube001.services.stellar-ops.com/

elizabethengelman changed the title ~~Add a transaction cli-sign page~~ Sign a tx from link opened via CLI Aug 29, 2024

elizabethengelman mentioned this pull request Aug 29, 2024

Feat/sign with lab stellar/stellar-cli#1579

Closed

1 task

elizabethengelman added 4 commits August 30, 2024 10:17

Add a transaction cli-sign page

827fd22

Add component to set network by passphrase only

6c8d95d

Remove cli-sign route

5ebecaa

Parse passphrase and xdr in new provider (instead of NetworkSelector)

9fe349c

elizabethengelman force-pushed the feat/sign-tx-from-cli branch from 8f219d1 to 00a8833 Compare August 30, 2024 14:17

elizabethengelman commented Sep 3, 2024

View reviewed changes

elizabethengelman force-pushed the feat/sign-tx-from-cli branch from 00a8833 to 4a0b479 Compare September 3, 2024 18:25

Cleanup

17c817b

elizabethengelman force-pushed the feat/sign-tx-from-cli branch from 4a0b479 to 17c817b Compare September 3, 2024 18:27

elizabethengelman marked this pull request as ready for review September 3, 2024 18:28

janewang requested a review from quietbits September 3, 2024 22:42

Add transaction/cli-sign back

64bceae

Merge branch 'master' into feat/sign-tx-from-cli

cffba46

quietbits reviewed Sep 4, 2024

View reviewed changes

Merge branch 'master' into feat/sign-tx-from-cli

c8bcebc

elizabethengelman added 2 commits September 6, 2024 12:42

Move NetworkByPassworkProvder logic into cli-sign

056775a

Keep design system import above global

338ea38

quietbits approved these changes Sep 9, 2024

View reviewed changes

elizabethengelman and others added 2 commits September 10, 2024 13:06

Update src/app/(sidebar)/transaction/cli-sign/page.tsx

8d0346c

Co-authored-by: Iveta <quietbits@users.noreply.github.com>

Merge branch 'master' into feat/sign-tx-from-cli

dadf311

Update useEffect dependencies

a240bf0

quietbits merged commit c94420e into stellar:master Sep 11, 2024
2 checks passed

elizabethengelman deleted the feat/sign-tx-from-cli branch September 11, 2024 13:01

elizabethengelman mentioned this pull request Sep 13, 2024

Feat/sign with lab stellar/stellar-cli#1604

Open

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sign a tx from link opened via CLI #987

Sign a tx from link opened via CLI #987

elizabethengelman commented Aug 27, 2024 •

edited

Loading

stellar-jenkins commented Aug 27, 2024

stellar-jenkins commented Aug 28, 2024

stellar-jenkins commented Aug 29, 2024

stellar-jenkins commented Aug 29, 2024

stellar-jenkins commented Aug 30, 2024

elizabethengelman Sep 3, 2024

stellar-jenkins commented Sep 3, 2024

stellar-jenkins commented Sep 3, 2024

stellar-jenkins commented Sep 4, 2024

stellar-jenkins commented Sep 4, 2024

quietbits Sep 4, 2024

quietbits Sep 4, 2024

elizabethengelman Sep 6, 2024

stellar-jenkins commented Sep 6, 2024

stellar-jenkins commented Sep 6, 2024

Ifropc commented Sep 6, 2024

quietbits Sep 9, 2024

elizabethengelman Sep 10, 2024

stellar-jenkins commented Sep 10, 2024

stellar-jenkins commented Sep 10, 2024

stellar-jenkins commented Sep 10, 2024

Sign a tx from link opened via CLI #987

Sign a tx from link opened via CLI #987

Conversation

elizabethengelman commented Aug 27, 2024 • edited Loading

stellar-jenkins commented Aug 27, 2024

stellar-jenkins commented Aug 28, 2024

stellar-jenkins commented Aug 29, 2024

stellar-jenkins commented Aug 29, 2024

stellar-jenkins commented Aug 30, 2024

elizabethengelman Sep 3, 2024

Choose a reason for hiding this comment

stellar-jenkins commented Sep 3, 2024

stellar-jenkins commented Sep 3, 2024

stellar-jenkins commented Sep 4, 2024

stellar-jenkins commented Sep 4, 2024

quietbits Sep 4, 2024

Choose a reason for hiding this comment

quietbits Sep 4, 2024

Choose a reason for hiding this comment

elizabethengelman Sep 6, 2024

Choose a reason for hiding this comment

stellar-jenkins commented Sep 6, 2024

stellar-jenkins commented Sep 6, 2024

Ifropc commented Sep 6, 2024

quietbits Sep 9, 2024

Choose a reason for hiding this comment

elizabethengelman Sep 10, 2024

Choose a reason for hiding this comment

stellar-jenkins commented Sep 10, 2024

stellar-jenkins commented Sep 10, 2024

stellar-jenkins commented Sep 10, 2024

elizabethengelman commented Aug 27, 2024 •

edited

Loading