enhancement: Change signature of ClientOption.signTransaction to be able to pass KeyPair #1063

[od-hunter]

Change signature of ClientOption.signTransaction to be able to pass KeyPair #1063

Closes #1063

Pull Request Description

Summary

This pull request modifies the ClientOptions type to allow the signTransaction property to accept a Keypair in addition to a function. This change simplifies the process of signing transactions, especially for testing and simple applications, by allowing users to directly use a Keypair without needing to implement a custom signing function.

Changes Made

1. Updated ClientOptions Type:

• Modified the signTransaction property to accept either a SignTransaction function or a Keypair.

export type ClientOptions = {
  // ... other properties
  signTransaction?: SignTransaction | Keypair;
  // ... other properties
};

2. Modified AssembledTransaction Class:

• Updated the sign method to handle the case where signTransaction is a Keypair.
• If a Keypair is provided, it uses the basicNodeSigner to create a signing function.

sign = async ({
  force = false,
  signTransaction = this.options.signTransaction,
}: {
  force?: boolean;
  signTransaction?: ClientOptions["signTransaction"];
} = {}): Promise<void> => {
  // ... existing logic

  // Check if signTransaction is a Keypair
  let signFunction: SignTransaction | undefined;

  if (signTransaction instanceof Keypair) {
    const keypair = signTransaction;
    signFunction = basicNodeSigner(keypair, this.options.networkPassphrase).signTransaction;
  } else if (typeof signTransaction === 'function') {
    signFunction = signTransaction;
  }
  // ... existing logic
    const signOpts: Parameters<SignTransaction>[1] = {
      networkPassphrase: this.options.networkPassphrase,
    };
};

3. Type Safety:

• Ensured that TypeScript correctly infers types when preparing signing options.

[od-hunter]

Hi @chadoh , @Shaptic please review.

[od-hunter]

Happy holidays @Shaptic , @chadoh please review 🥲

[chadoh]

This looks pretty good! Please update at least some of the e2e tests to show that it works. If it's easiest, you can change just test/e2e/src/util.ts to pass the keypair instead of using basicNodeSigner, which will update all the tests. But then we will need one new test using basicNodeSigner to ensure that both approaches continue to work.

[od-hunter]

@chadoh changes implemented.

[od-hunter]

Hi @chadoh , please review, change has been implemented.

[od-hunter]

Hi @chadoh , please review