@privy-io/node 0.6.2 → 0.8.0

package/src/solana-kit.ts

@@ -0,0 +1,148 @@
+import {
+  getBase64EncodedWireTransaction,
+  getTransactionDecoder,
+  type Address,
+  type SignatureBytes,
+} from '@solana/kit';
+import { base58, base64 } from '@scure/base';
+import type {
+  MessagePartialSigner,
+  TransactionPartialSigner,
+  TransactionSendingSigner,
+} from '@solana/signers';
+import type { AuthorizationContext } from './lib/authorization';
+import type { PrivyClient } from './public-api/PrivyClient';
+
+export interface CreateSolanaKitSignerInput {
+  /** ID for the wallet. */
+  walletId: string;
+  /** Solana address for the wallet. */
+  address: Address;
+  /** Authorization context for the wallet. */
+  authorizationContext?: AuthorizationContext;
+  /**
+   * CAIP-2 for the Solana network.
+   * @optional This field is only required for sending transactions.
+   */
+  caip2?: string;
+}
+
+/**
+ * Defines a signer that uses a {@link PrivyClient} to sign messages and transactions.
+ *
+ * It implements the {@link MessagePartialSigner}, {@link TransactionPartialSigner},
+ * and {@link TransactionSendingSigner} interfaces and keeps track of the ID of the
+ * wallet used to sign them.
+ */
+export type SolanaKitSigner = MessagePartialSigner &
+  TransactionPartialSigner &
+  TransactionSendingSigner &
+  Readonly<{ walletId: string; address: Address }>;
+
+/**
+ * Creates a {@link SolanaKitSigner} from a provided Privy wallet and authorization context.
+ *
+ * The returned signer implements:
+ * - {@link MessagePartialSigner} - for signing messages via `signMessages`
+ * - {@link TransactionPartialSigner} - for signing transactions via `signTransactions`
+ * - {@link TransactionSendingSigner} - for signing and sending transactions via `signAndSendTransactions`
+ *
+ * And it keeps track of the `walletId` used to sign them.
+ *
+ * @example
+ * ```ts
+ * import { PrivyClient } from '@privy-io/node';
+ * import { createSolanaKitSigner } from '@privy-io/node/solana-kit';
+ * import { address } from '@solana/kit';
+ *
+ * const client = new PrivyClient({ appId: '...', appSecret: '...' });
+ * const signer = createSolanaKitSigner(client, {
+ *   walletId: 'wallet-id',
+ *   address: address('...'),
+ * });
+ * ```
+ */
+export function createSolanaKitSigner(
+  client: PrivyClient,
+  { walletId, address, authorizationContext, caip2 }: CreateSolanaKitSignerInput,
+): SolanaKitSigner {
+  const authCtxOptions = authorizationContext ? { authorization_context: authorizationContext } : {};
+  return {
+    address,
+    walletId,
+
+    async signMessages(messages) {
+      return await Promise.all(
+        messages.map(async (message) => {
+          const response = await client
+            .wallets()
+            .solana()
+            .signMessage(walletId, {
+              message: message.content,
+              ...authCtxOptions,
+            });
+
+          // We assert the signature is valid by casting to `SignatureBytes`
+          const signatureBytes = base64.decode(response.signature) as SignatureBytes;
+          return {
+            [address]: signatureBytes,
+          };
+        }),
+      );
+    },
+
+    async signTransactions(transactions) {
+      return await Promise.all(
+        transactions.map(async (transaction) => {
+          // Convert compiled transaction to wire format base64
+          const transactionBase64 = getBase64EncodedWireTransaction(transaction);
+
+          const response = await client
+            .wallets()
+            .solana()
+            .signTransaction(walletId, {
+              transaction: transactionBase64,
+              ...authCtxOptions,
+            });
+
+          const signedTransactionBytes = base64.decode(response.signed_transaction);
+          const decoder = getTransactionDecoder();
+          const signedTransaction = decoder.decode(signedTransactionBytes);
+
+          return {
+            // We assert the signature exists by asserting as non-null
+            [address]: signedTransaction.signatures[address]!,
+          };
+        }),
+      );
+    },
+
+    async signAndSendTransactions(transactions) {
+      if (!caip2) {
+        throw new Error(
+          'CAIP-2 is required for sending transactions. Please provide one in the createSolanaKitSigner input.',
+        );
+      }
+
+      return await Promise.all(
+        transactions.map(async (transaction) => {
+          // Convert compiled transaction to wire format base64
+          const transactionBase64 = getBase64EncodedWireTransaction(transaction);
+
+          const response = await client
+            .wallets()
+            .solana()
+            .signAndSendTransaction(walletId, {
+              transaction: transactionBase64,
+              caip2,
+              ...authCtxOptions,
+            });
+
+          // The hash returned is base58-encoded, convert to bytes
+          // and cast as a SignatureBytes, asserting it is a valid signature.
+          return base58.decode(response.hash) as SignatureBytes;
+        }),
+      );
+    },
+  };
+}

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.6.2'; // x-release-please-version
+export const VERSION = '0.8.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.6.2";
+export declare const VERSION = "0.8.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.6.2";
+export declare const VERSION = "0.8.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.6.2'; // x-release-please-version
+exports.VERSION = '0.8.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.6.2'; // x-release-please-version
+export const VERSION = '0.8.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map