Add versioned transaction methods to adapter interface #558

jstarry · 2022-09-12T19:06:18Z

Changes:

Add supportedTransactionVersions property to the adapter interface so that wallets can declare whether they support versioned transactions and list the versions they support.
Add generic typing for signTransaction and signAllTransactions which detects supported transaction versions for each adapter and adjusts parameter and return types appropriately.
Add generic typing for sendTransaction which detects supported transaction versions for each adapter and adjusts parameter types appropriately

jordaaash

Approach looks good, but with the Wallet Standard approaching imminently, I don't want to add to the public API if it can be avoided. Let me know what you think!

packages/core/base/src/signer.ts

packages/core/base/src/adapter.ts

packages/core/react/src/WalletProvider.tsx

packages/wallets/blocto/src/adapter.ts

packages/core/base/src/adapter.ts

packages/wallets/alpha/src/adapter.ts

packages/core/base/src/signer.ts

packages/core/react/src/WalletProvider.tsx

packages/core/react/src/useAnchorWallet.ts

packages/wallets/alpha/src/adapter.ts

jordaaash · 2022-09-15T01:06:42Z

packages/core/base/src/signer.ts

+    signTransaction<T extends TransactionOrVersionedTransaction<this['supportedTransactionVersions']>>(
+        transaction: T
+    ): Promise<T>;
+    signAllTransactions<T extends TransactionOrVersionedTransaction<this['supportedTransactionVersions']>>(
+        transactions: T[]
+    ): Promise<T[]>;


Okay, I think these types are very reasonable now. By inferring SupportedTransactionVersions from the actual implementer, and making the methods return the type they were called with, existing code that expects signTransaction(transaction: Transaction): Promise<Transaction> will just work.

jordaaash · 2022-09-15T01:08:52Z

packages/core/react/src/WalletProvider.tsx

@@ -240,10 +247,10 @@ export const WalletProvider: FC<WalletProviderProps> = ({
    );

    // Sign a transaction if the wallet supports it
-    const signTransaction = useMemo(
+    const signTransaction: SignerWalletAdapterProps['signTransaction'] | undefined = useMemo(


This type is still not perfect in the sense that a dev will see (transaction: Transaction | VersionedTransaction) as the parameter type, so they have to know to check the adapter for supportedTransactionVersions. But it is functional and nonbreaking, because it will always be expected to return whichever type it was called with.

That seems totally fine to me

jordaaash · 2022-09-15T01:11:23Z

packages/wallets/alpha/src/adapter.ts

@@ -185,13 +186,13 @@ export class AlphaWalletAdapter extends BaseMessageSignerWalletAdapter {
        }
    }

-    async signTransaction(transaction: Transaction): Promise<Transaction> {
+    async signTransaction<T extends Transaction>(transaction: T): Promise<T> {


We know that transaction will only ever be Transaction now because supportedTransactionVersions is null, but we still have to implement it this way because the interface declares it like this. All this means is that if a subtype of Transaction was passed to signTransaction, the wallet should return the same subtype. In practice, this doesn't matter because there are no subclasses of Transaction in web3.js to worry about.

jordaaash · 2022-09-15T01:11:58Z

packages/wallets/alpha/src/adapter.ts

        try {
            const wallet = this._wallet;
            if (!wallet) throw new WalletNotConnectedError();

            try {
-                return (await wallet.signTransaction(transaction)) || transaction;
+                return ((await wallet.signTransaction(transaction)) as T) || transaction;


Here we have to perform the one ugly bit, where we cast Transaction as T even though we know it will be valid.

jstarry · 2022-09-15T03:35:54Z

The last round of changes look solid to me. I just built the example app with some test code that called signTransaction from useWallet and API type resolution works great. Your call but I say ship it now and we can iterate quickly on if there are any minor issues that pop up

jordaaash · 2022-09-15T04:18:11Z

Sounds good, I'll test a bit and merge tomorrow.

into versioned-tx

jstarry added 2 commits September 12, 2022 14:22

Bump @solana/web3.js version to v1.59.1

5269c16

Add versioned transaction methods to adapter interface

5ce4a3c

jstarry requested a review from jordaaash September 12, 2022 19:16

jordaaash reviewed Sep 12, 2022

View reviewed changes

feedback

1529a5b

jordaaash mentioned this pull request Sep 13, 2022

Remove generic Name parameter of WalletAdapterProps #560

Open

jordaaash added 8 commits September 13, 2022 14:36

update web3.js consistent with master

9ce97d6

Merge branch 'master' into versioned-tx

d5e9fd8

update lockfile

6762d53

organize imports, lint fix

8098e7b

refactor versioned transaction methods

f2f13b2

fix react types

f395866

add type guard for versioned txs

af2257a

alpha adapter test

f731ea1

jordaaash force-pushed the versioned-tx branch from 0eae986 to f731ea1 Compare September 13, 2022 21:02

jordaaash reviewed Sep 13, 2022

View reviewed changes

packages/wallets/alpha/src/adapter.ts Outdated Show resolved Hide resolved

jordaaash added 5 commits September 13, 2022 18:56

fixes

98ca6e8

fixes

aed4d7a

check out wallets from master

793b161

add supportedTransactionVersions flag to wallets

4b9132b

infer types

eb4011d

jordaaash force-pushed the versioned-tx branch from 3037869 to eb4011d Compare September 14, 2022 00:18

jordaaash reviewed Sep 14, 2022

View reviewed changes

packages/core/base/src/signer.ts Outdated Show resolved Hide resolved

jordaaash reviewed Sep 14, 2022

View reviewed changes

packages/core/react/src/WalletProvider.tsx Show resolved Hide resolved

jordaaash reviewed Sep 14, 2022

View reviewed changes

packages/core/react/src/useAnchorWallet.ts Outdated Show resolved Hide resolved

jordaaash reviewed Sep 14, 2022

View reviewed changes

packages/wallets/alpha/src/adapter.ts Show resolved Hide resolved

jordaaash added 4 commits September 14, 2022 15:23

organize imports

20bc5ed

have signAllTransactions check for versioned txs

04a6205

infer supportedTransactionVersions type from field

80d1d48

fix sign / signAll in all adapters

f2d50d6

remove hack

46ef36c

jordaaash force-pushed the versioned-tx branch from d19d746 to 46ef36c Compare September 15, 2022 01:02

jordaaash reviewed Sep 15, 2022

View reviewed changes

jstarry and others added 17 commits September 14, 2022 23:36

Add versioned transaction methods to adapter interface

a46ff71

feedback

43cde10

organize imports, lint fix

6505731

refactor versioned transaction methods

aa1e381

fix react types

1e8b5ee

add type guard for versioned txs

87b3943

alpha adapter test

6cc7d90

fixes

4369e40

fixes

8819905

check out wallets from master

bde0bb2

add supportedTransactionVersions flag to wallets

c2d14da

infer types

a801e06

organize imports

ebe79ec

have signAllTransactions check for versioned txs

1c0b0f6

infer supportedTransactionVersions type from field

6266bd8

fix sign / signAll in all adapters

6533919

remove hack

18878eb

jstarry force-pushed the versioned-tx branch from 46ef36c to 18878eb Compare September 15, 2022 03:41

Merge branch 'versioned-tx' of https://github.com/jstarry/wallet-adapter

ddf04df

into versioned-tx

jordaaash merged commit b109484 into anza-xyz:master Sep 15, 2022

jstarry deleted the versioned-tx branch September 15, 2022 18:40

jstarry mentioned this pull request Sep 24, 2022

Versioned Transaction and Address Lookup Table feature activation solana-labs/solana#26391

Closed

65 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add versioned transaction methods to adapter interface #558

Add versioned transaction methods to adapter interface #558

jstarry commented Sep 12, 2022 •

edited

Loading

jordaaash left a comment

jordaaash Sep 15, 2022

jordaaash Sep 15, 2022 •

edited

Loading

jstarry Sep 15, 2022

jordaaash Sep 15, 2022 •

edited

Loading

jordaaash Sep 15, 2022

jstarry commented Sep 15, 2022

jordaaash commented Sep 15, 2022

Add versioned transaction methods to adapter interface #558

Add versioned transaction methods to adapter interface #558

Conversation

jstarry commented Sep 12, 2022 • edited Loading

Changes:

jordaaash left a comment

Choose a reason for hiding this comment

jordaaash Sep 15, 2022

Choose a reason for hiding this comment

jordaaash Sep 15, 2022 • edited Loading

Choose a reason for hiding this comment

jstarry Sep 15, 2022

Choose a reason for hiding this comment

jordaaash Sep 15, 2022 • edited Loading

Choose a reason for hiding this comment

jordaaash Sep 15, 2022

Choose a reason for hiding this comment

jstarry commented Sep 15, 2022

jordaaash commented Sep 15, 2022

jstarry commented Sep 12, 2022 •

edited

Loading

jordaaash Sep 15, 2022 •

edited

Loading

jordaaash Sep 15, 2022 •

edited

Loading