@solana/signers 5.0.1-canary-20251119203851 → 5.1.0-canary-20251203213248

package/dist/types/sign-offchain-message.d.ts

@@ -0,0 +1,55 @@
+import { FullySignedOffchainMessageEnvelope, OffchainMessage, OffchainMessageEnvelope, OffchainMessageSignatory, OffchainMessageWithRequiredSignatories } from '@solana/offchain-messages';
+import { MessagePartialSignerConfig } from './message-partial-signer';
+import { OffchainMessageSignatorySigner } from './offchain-message-signer';
+/**
+ * Extracts all {@link MessageSigner | MessageSigners} inside the provided offchain message and uses
+ * them to return a signed offchain message envelope.
+ *
+ * It first uses all {@link MessageModifyingSigner | MessageModifyingSigners} sequentially before
+ * using all {@link MessagePartialSigner | MessagePartialSigners} in parallel.
+ *
+ * If a composite signer implements both interfaces, it will be used as a
+ * {@link MessageModifyingSigner} if no other signer implements that interface. Otherwise, it will
+ * be used as a {@link MessagePartialSigner}.
+ *
+ * @example
+ * ```ts
+ * const signedOffchainMessageEnvelope = await partiallySignOffchainMessageWithSigners(offchainMessage);
+ * ```
+ *
+ * It also accepts an optional {@link AbortSignal} that will be propagated to all signers.
+ *
+ * ```ts
+ * const signedOffchainMessageEnvelope = await partiallySignOffchainMessageWithSigners(offchainMessage, {
+ *     abortSignal: myAbortController.signal,
+ * });
+ * ```
+ *
+ * @see {@link signOffchainMessageWithSigners}
+ */
+export declare function partiallySignOffchainMessageWithSigners(offchainMessage: OffchainMessageWithRequiredSignatories<OffchainMessageSignatory | OffchainMessageSignatorySigner> & Omit<OffchainMessage, 'requiredSignatories'>, config?: MessagePartialSignerConfig): Promise<OffchainMessageEnvelope>;
+/**
+ * Extracts all {@link MessageSigner | MessageSigners} inside the provided offchain message and uses
+ * them to return a signed offchain message envelope before asserting that all signatures required
+ * by the message are present.
+ *
+ * This function delegates to the {@link partiallySignOffchainMessageWithSigners} function
+ * in order to extract signers from the offchain message and sign it.
+ *
+ * @example
+ * ```ts
+ * const mySignedOffchainMessageEnvelope = await signOffchainMessageWithSigners(myOffchainMessage);
+ *
+ * // With additional config.
+ * const mySignedOffchainMessageEnvelope = await signOffchainMessageWithSigners(myOffchainMessage, {
+ *     abortSignal: myAbortController.signal,
+ * });
+ *
+ * // We now know the offchain message is fully signed.
+ * mySignedOffchainMessageEnvelope satisfies FullySignedOffchainMessageEnvelope;
+ * ```
+ *
+ * @see {@link partiallySignOffchainMessageWithSigners}
+ */
+export declare function signOffchainMessageWithSigners(offchainMessage: OffchainMessageWithRequiredSignatories<OffchainMessageSignatory | OffchainMessageSignatorySigner> & Omit<OffchainMessage, 'requiredSignatories'>, config?: MessagePartialSignerConfig): Promise<FullySignedOffchainMessageEnvelope & OffchainMessageEnvelope>;
+//# sourceMappingURL=sign-offchain-message.d.ts.map

package/dist/types/sign-offchain-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign-offchain-message.d.ts","sourceRoot":"","sources":["../../src/sign-offchain-message.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,kCAAkC,EAClC,eAAe,EACf,uBAAuB,EACvB,wBAAwB,EACxB,sCAAsC,EACzC,MAAM,2BAA2B,CAAC;AAOnC,OAAO,EAAgD,0BAA0B,EAAE,MAAM,0BAA0B,CAAC;AAEpH,OAAO,EAAiC,8BAA8B,EAAE,MAAM,2BAA2B,CAAC;AAG1G;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,uCAAuC,CACzD,eAAe,EAAE,sCAAsC,CAAC,wBAAwB,GAAG,8BAA8B,CAAC,GAC9G,IAAI,CAAC,eAAe,EAAE,qBAAqB,CAAC,EAChD,MAAM,CAAC,EAAE,0BAA0B,GACpC,OAAO,CAAC,uBAAuB,CAAC,CAKlC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,8BAA8B,CAChD,eAAe,EAAE,sCAAsC,CAAC,wBAAwB,GAAG,8BAA8B,CAAC,GAC9G,IAAI,CAAC,eAAe,EAAE,qBAAqB,CAAC,EAChD,MAAM,CAAC,EAAE,0BAA0B,GACpC,OAAO,CAAC,kCAAkC,GAAG,uBAAuB,CAAC,CAIvE"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@solana/signers",
-  "version": "5.0.1-canary-20251119203851",
+  "version": "5.1.0-canary-20251203213248",
   "description": "An abstraction layer over signing messages and transactions in Solana",
   "homepage": "https://www.solanakit.com/api#solanasigners",
   "exports": {
@@ -55,14 +55,15 @@
     "maintained node versions"
   ],
   "dependencies": {
-    "@solana/addresses": "5.0.1-canary-20251119203851",
-    "@solana/instructions": "5.0.1-canary-20251119203851",
-    "@solana/errors": "5.0.1-canary-20251119203851",
-    "@solana/codecs-core": "5.0.1-canary-20251119203851",
-    "@solana/keys": "5.0.1-canary-20251119203851",
-    "@solana/transaction-messages": "5.0.1-canary-20251119203851",
-    "@solana/nominal-types": "5.0.1-canary-20251119203851",
-    "@solana/transactions": "5.0.1-canary-20251119203851"
+    "@solana/addresses": "5.1.0-canary-20251203213248",
+    "@solana/errors": "5.1.0-canary-20251203213248",
+    "@solana/instructions": "5.1.0-canary-20251203213248",
+    "@solana/keys": "5.1.0-canary-20251203213248",
+    "@solana/codecs-core": "5.1.0-canary-20251203213248",
+    "@solana/nominal-types": "5.1.0-canary-20251203213248",
+    "@solana/offchain-messages": "5.1.0-canary-20251203213248",
+    "@solana/transactions": "5.1.0-canary-20251203213248",
+    "@solana/transaction-messages": "5.1.0-canary-20251203213248"
   },
   "peerDependencies": {
     "typescript": ">=5.3.3"