@sovereign-sdk/web3 0.13.0 → 0.14.0

package/dist/index.d.mts

@@ -4,7 +4,7 @@ import * as SovereignClient from '@sovereign-sdk/client';
 export { SovereignClient };
 import { RollupSchema as RollupSchema$1, Serializer as Serializer$1 } from '@sovereign-sdk/serializers';
 import { Signer } from '@sovereign-sdk/signers';
-import { TxDetails, UnsignedTransaction, Transaction } from '@sovereign-sdk/types';
+import { TxDetails, UnsignedTransaction, Transaction, TransactionV1 } from '@sovereign-sdk/types';
 
 /**
  * Encodes a public key as a bech32m address with the given human-readable part (hrp).
@@ -419,6 +419,10 @@ declare abstract class Serializer {
 type SolanaOffchainUnsignedTransaction<RuntimeCall> = UnsignedTransaction<RuntimeCall> & {
     chain_name: string;
 };
+type SolanaOffchainUnsignedTransactionV1<RuntimeCall> = SolanaOffchainUnsignedTransaction<RuntimeCall> & {
+    multisig_id: string;
+    version: number;
+};
 type SolanaOffchainSimpleMessage = {
     signed_message: Uint8Array;
     chain_hash: Uint8Array;
@@ -429,12 +433,37 @@ type SolanaOffchainSpecCompliantMessage = {
     signed_message_with_preamble: Uint8Array;
     signature: Uint8Array;
 };
+type SolanaOffchainSimpleMultisigMessage = {
+    /** Wire format: [0x80][JSON payload]. The 0x80 prefix is a parsing discriminator only. */
+    wire_bytes: Uint8Array;
+    chain_hash: Uint8Array;
+    signatures: Array<{
+        signature: Uint8Array;
+        pub_key: Uint8Array;
+    }>;
+    unused_pub_keys: Uint8Array[];
+    min_signers: number;
+};
+type SolanaOffchainSpecCompliantMultisigMessage = {
+    signed_message_with_preamble: Uint8Array;
+    signatures: Uint8Array[];
+    signer_bitfield: number;
+    min_signers: number;
+};
 type Authenticator = "standard" | "solanaSimple" | "solana" | "solanaAuto";
-/**
- * Creates a Solana offchain message preamble according to the spec.
- * See https://docs.anza.xyz/proposals/off-chain-message-signing#message-preamble
- */
-declare function createSolanaPreamble(pubkey: Uint8Array, chainHash: Uint8Array, messageLength: number): Uint8Array;
+type SolanaMultisigAuthenticator = "solanaSimple" | "solana";
+type SolanaMultisigParams = {
+    multisigAddress: Uint8Array;
+    multisigPubkeys: Uint8Array[];
+};
+type SolanaMultisigSubmitParams = {
+    authenticator: "standard";
+} | ({
+    authenticator: SolanaMultisigAuthenticator;
+} & SolanaMultisigParams);
+type SolanaMultisigSignParams = SolanaMultisigSubmitParams & {
+    signer: Signer;
+};
 declare class SolanaSignableRollup<RuntimeCall> {
     private inner;
     private solanaEndpoint;
@@ -458,6 +487,10 @@ declare class SolanaSignableRollup<RuntimeCall> {
      * Submits a Solana spec-compliant message to the rollup.
      */
     private submitSolanaSpecMessage;
+    /**
+     * Submits a Solana spec-compliant multisig message to the rollup.
+     */
+    private submitSolanaSpecMultisigMessage;
     /**
      * Helper to build an unsigned transaction using the standard type builder.
      */
@@ -466,6 +499,15 @@ declare class SolanaSignableRollup<RuntimeCall> {
      * Helper to build a transaction result object.
      */
     private buildTransactionResult;
+    /**
+     * Concatenates a Solana preamble with the message bytes it signs.
+     */
+    private combinePreambleAndMessage;
+    /**
+     * Validates and canonicalizes the multisig pubkey list.
+     * The canonical order is lexicographic by raw pubkey bytes.
+     */
+    private canonicalizeMultisigPubkeys;
     /**
      * Helper to create and serialize a SolanaOffchainUnsignedTransaction to JSON bytes.
      */
@@ -505,6 +547,46 @@ declare class SolanaSignableRollup<RuntimeCall> {
         signer: Signer;
         authenticator: Authenticator;
     }, options?: SovereignClient__default.RequestOptions): Promise<TransactionResult<Transaction<RuntimeCall>>>;
+    /**
+     * Creates V1 JSON bytes for a multisig transaction, including multisig_id and version.
+     * The resulting JSON is what each signer signs directly (no discriminator prefix).
+     */
+    private createMultisigJsonBytes;
+    /**
+     * Creates the preamble+JSON bytes signed by every signer in a spec-compliant multisig flow.
+     */
+    private createSpecCompliantMultisigSignedMessage;
+    /**
+     * Signs an unsigned transaction using Solana offchain simple multisig signing.
+     */
+    private signForSolanaSimpleMultisig;
+    /**
+     * Signs an unsigned transaction using the spec-compliant multisig preamble.
+     */
+    private signForSolanaSpecMultisig;
+    /**
+     * Signs an unsigned transaction for use in a Solana offchain multisig.
+     *
+     * `authenticator: "standard"` delegates directly to the wrapped standard rollup.
+     * `authenticator: "solanaSimple"` signs the V1 JSON payload directly.
+     * `authenticator: "solana"` signs the spec-compliant preamble+JSON bytes.
+     * Solana multisig authenticators treat `multisigPubkeys` as an unordered set and
+     * canonicalize it before signing.
+     */
+    signTransactionForMultisig(unsignedTx: UnsignedTransaction<RuntimeCall>, params: SolanaMultisigSignParams): Promise<Transaction<RuntimeCall>>;
+    /**
+     * Builds a spec-compliant multisig envelope from a V1 transaction and ordered multisig pubkeys.
+     */
+    private buildSpecCompliantMultisigEnvelope;
+    /**
+     * Submits a multisig transaction using the Solana offchain simple multisig format.
+     *
+     * Accepts the V1 transaction produced by `MultisigTransaction.asTransaction()`.
+     * `authenticator: "standard"` delegates directly to the wrapped standard rollup.
+     * Solana authenticators rebuild the appropriate Solana multisig envelope and
+     * submit it to the Solana offchain endpoint.
+     */
+    submitMultisigTransaction(multisigTx: TransactionV1<RuntimeCall>, params: SolanaMultisigSubmitParams): Promise<SovereignClient__default.Sequencer.TxCreateResponse>;
     /**
      * Submits a standard transaction.
      */
@@ -521,6 +603,11 @@ declare class SolanaSignableRollup<RuntimeCall> {
     dedup(address: Uint8Array): Promise<Dedup>;
     serializer(): Promise<Serializer>;
     chainHash(): Promise<Uint8Array>;
+    /**
+     * Pre-fetches the rollup schema, populating the serializer and chain hash caches.
+     * Call this during initialization to avoid the latency of lazy-loading on the first transaction.
+     */
+    hydrate(): Promise<void>;
     healthcheck(timeout?: number): Promise<boolean>;
     subscribe<T extends keyof SubscriptionToCallbackMap>(type: T, callback: SubscriptionToCallbackMap[T]): Subscription;
     get context(): StandardRollupContext;
@@ -536,6 +623,28 @@ declare class SolanaSignableRollup<RuntimeCall> {
      * Helper method to serialize a SolanaOffchainSpecCompliantMessage using borsh encoding.
      */
     private serializeSolanaSpecMessage;
+    /**
+     * Serializes a SolanaOffchainSimpleMultisigMessage using borsh encoding.
+     * Layout matches the Rust struct:
+     *   [u32 LE: wire_bytes.len][wire_bytes]
+     *   [32 bytes: chain_hash]
+     *   [u32 LE: signatures.len]
+     *     for each: [64 bytes: signature][32 bytes: pub_key]
+     *   [u32 LE: unused_pub_keys.len]
+     *     for each: [32 bytes: pub_key]
+     *   [u8: min_signers]
+     */
+    private serializeSolanaMultisigMessage;
+    /**
+     * Serializes a SolanaOffchainSpecCompliantMultisigMessage using borsh encoding.
+     * Layout matches the Rust struct:
+     *   [u32 LE: signed_message_with_preamble.len][signed_message_with_preamble]
+     *   [u32 LE: signatures.len]
+     *     for each: [64 bytes: signature]
+     *   [u32 LE: signer_bitfield]
+     *   [u8: min_signers]
+     */
+    private serializeSolanaSpecMultisigMessage;
 }
 declare function createSolanaSignableRollup<RuntimeCall>(rollupConfig?: Partial<RollupConfig<DeepPartial<StandardRollupContext>>>, solanaEndpoint?: string): Promise<SolanaSignableRollup<RuntimeCall>>;
 
@@ -559,4 +668,4 @@ declare class SchemaError extends SovereignError {
     constructor(message: string, reason: string, schema: object);
 }
 
-export { type Authenticator, type BaseTypeSpec, type CallParams, DEFAULT_TX_DETAILS, type Dedup, type EventPayload, InvalidRollupConfigError, Rollup, type RollupConfig, type RollupContext, type RollupTypeSpec, SchemaError, type SignerParams, type SimulateParams, type SolanaOffchainSimpleMessage, type SolanaOffchainSpecCompliantMessage, type SolanaOffchainUnsignedTransaction, SolanaSignableRollup, SovereignError, StandardRollup, type StandardRollupContext, type StandardRollupSpec, type Subscription, type TransactionContext, type TransactionResult, type TypeBuilder, type UnsignedTransactionContext, VersionMismatchError, addressFromPublicKey, createSolanaPreamble, createSolanaSignableRollup, createStandardRollup, standardTypeBuilder };
+export { type Authenticator, type BaseTypeSpec, type CallParams, DEFAULT_TX_DETAILS, type Dedup, type EventPayload, InvalidRollupConfigError, Rollup, type RollupConfig, type RollupContext, type RollupTypeSpec, SchemaError, type SignerParams, type SimulateParams, type SolanaMultisigAuthenticator, type SolanaMultisigSignParams, type SolanaMultisigSubmitParams, type SolanaOffchainSimpleMessage, type SolanaOffchainSimpleMultisigMessage, type SolanaOffchainSpecCompliantMessage, type SolanaOffchainSpecCompliantMultisigMessage, type SolanaOffchainUnsignedTransaction, type SolanaOffchainUnsignedTransactionV1, SolanaSignableRollup, SovereignError, StandardRollup, type StandardRollupContext, type StandardRollupSpec, type Subscription, type TransactionContext, type TransactionResult, type TypeBuilder, type UnsignedTransactionContext, VersionMismatchError, addressFromPublicKey, createSolanaSignableRollup, createStandardRollup, standardTypeBuilder };

package/dist/index.d.ts

@@ -4,7 +4,7 @@ import * as SovereignClient from '@sovereign-sdk/client';
 export { SovereignClient };
 import { RollupSchema as RollupSchema$1, Serializer as Serializer$1 } from '@sovereign-sdk/serializers';
 import { Signer } from '@sovereign-sdk/signers';
-import { TxDetails, UnsignedTransaction, Transaction } from '@sovereign-sdk/types';
+import { TxDetails, UnsignedTransaction, Transaction, TransactionV1 } from '@sovereign-sdk/types';
 
 /**
  * Encodes a public key as a bech32m address with the given human-readable part (hrp).
@@ -419,6 +419,10 @@ declare abstract class Serializer {
 type SolanaOffchainUnsignedTransaction<RuntimeCall> = UnsignedTransaction<RuntimeCall> & {
     chain_name: string;
 };
+type SolanaOffchainUnsignedTransactionV1<RuntimeCall> = SolanaOffchainUnsignedTransaction<RuntimeCall> & {
+    multisig_id: string;
+    version: number;
+};
 type SolanaOffchainSimpleMessage = {
     signed_message: Uint8Array;
     chain_hash: Uint8Array;
@@ -429,12 +433,37 @@ type SolanaOffchainSpecCompliantMessage = {
     signed_message_with_preamble: Uint8Array;
     signature: Uint8Array;
 };
+type SolanaOffchainSimpleMultisigMessage = {
+    /** Wire format: [0x80][JSON payload]. The 0x80 prefix is a parsing discriminator only. */
+    wire_bytes: Uint8Array;
+    chain_hash: Uint8Array;
+    signatures: Array<{
+        signature: Uint8Array;
+        pub_key: Uint8Array;
+    }>;
+    unused_pub_keys: Uint8Array[];
+    min_signers: number;
+};
+type SolanaOffchainSpecCompliantMultisigMessage = {
+    signed_message_with_preamble: Uint8Array;
+    signatures: Uint8Array[];
+    signer_bitfield: number;
+    min_signers: number;
+};
 type Authenticator = "standard" | "solanaSimple" | "solana" | "solanaAuto";
-/**
- * Creates a Solana offchain message preamble according to the spec.
- * See https://docs.anza.xyz/proposals/off-chain-message-signing#message-preamble
- */
-declare function createSolanaPreamble(pubkey: Uint8Array, chainHash: Uint8Array, messageLength: number): Uint8Array;
+type SolanaMultisigAuthenticator = "solanaSimple" | "solana";
+type SolanaMultisigParams = {
+    multisigAddress: Uint8Array;
+    multisigPubkeys: Uint8Array[];
+};
+type SolanaMultisigSubmitParams = {
+    authenticator: "standard";
+} | ({
+    authenticator: SolanaMultisigAuthenticator;
+} & SolanaMultisigParams);
+type SolanaMultisigSignParams = SolanaMultisigSubmitParams & {
+    signer: Signer;
+};
 declare class SolanaSignableRollup<RuntimeCall> {
     private inner;
     private solanaEndpoint;
@@ -458,6 +487,10 @@ declare class SolanaSignableRollup<RuntimeCall> {
      * Submits a Solana spec-compliant message to the rollup.
      */
     private submitSolanaSpecMessage;
+    /**
+     * Submits a Solana spec-compliant multisig message to the rollup.
+     */
+    private submitSolanaSpecMultisigMessage;
     /**
      * Helper to build an unsigned transaction using the standard type builder.
      */
@@ -466,6 +499,15 @@ declare class SolanaSignableRollup<RuntimeCall> {
      * Helper to build a transaction result object.
      */
     private buildTransactionResult;
+    /**
+     * Concatenates a Solana preamble with the message bytes it signs.
+     */
+    private combinePreambleAndMessage;
+    /**
+     * Validates and canonicalizes the multisig pubkey list.
+     * The canonical order is lexicographic by raw pubkey bytes.
+     */
+    private canonicalizeMultisigPubkeys;
     /**
      * Helper to create and serialize a SolanaOffchainUnsignedTransaction to JSON bytes.
      */
@@ -505,6 +547,46 @@ declare class SolanaSignableRollup<RuntimeCall> {
         signer: Signer;
         authenticator: Authenticator;
     }, options?: SovereignClient__default.RequestOptions): Promise<TransactionResult<Transaction<RuntimeCall>>>;
+    /**
+     * Creates V1 JSON bytes for a multisig transaction, including multisig_id and version.
+     * The resulting JSON is what each signer signs directly (no discriminator prefix).
+     */
+    private createMultisigJsonBytes;
+    /**
+     * Creates the preamble+JSON bytes signed by every signer in a spec-compliant multisig flow.
+     */
+    private createSpecCompliantMultisigSignedMessage;
+    /**
+     * Signs an unsigned transaction using Solana offchain simple multisig signing.
+     */
+    private signForSolanaSimpleMultisig;
+    /**
+     * Signs an unsigned transaction using the spec-compliant multisig preamble.
+     */
+    private signForSolanaSpecMultisig;
+    /**
+     * Signs an unsigned transaction for use in a Solana offchain multisig.
+     *
+     * `authenticator: "standard"` delegates directly to the wrapped standard rollup.
+     * `authenticator: "solanaSimple"` signs the V1 JSON payload directly.
+     * `authenticator: "solana"` signs the spec-compliant preamble+JSON bytes.
+     * Solana multisig authenticators treat `multisigPubkeys` as an unordered set and
+     * canonicalize it before signing.
+     */
+    signTransactionForMultisig(unsignedTx: UnsignedTransaction<RuntimeCall>, params: SolanaMultisigSignParams): Promise<Transaction<RuntimeCall>>;
+    /**
+     * Builds a spec-compliant multisig envelope from a V1 transaction and ordered multisig pubkeys.
+     */
+    private buildSpecCompliantMultisigEnvelope;
+    /**
+     * Submits a multisig transaction using the Solana offchain simple multisig format.
+     *
+     * Accepts the V1 transaction produced by `MultisigTransaction.asTransaction()`.
+     * `authenticator: "standard"` delegates directly to the wrapped standard rollup.
+     * Solana authenticators rebuild the appropriate Solana multisig envelope and
+     * submit it to the Solana offchain endpoint.
+     */
+    submitMultisigTransaction(multisigTx: TransactionV1<RuntimeCall>, params: SolanaMultisigSubmitParams): Promise<SovereignClient__default.Sequencer.TxCreateResponse>;
     /**
      * Submits a standard transaction.
      */
@@ -521,6 +603,11 @@ declare class SolanaSignableRollup<RuntimeCall> {
     dedup(address: Uint8Array): Promise<Dedup>;
     serializer(): Promise<Serializer>;
     chainHash(): Promise<Uint8Array>;
+    /**
+     * Pre-fetches the rollup schema, populating the serializer and chain hash caches.
+     * Call this during initialization to avoid the latency of lazy-loading on the first transaction.
+     */
+    hydrate(): Promise<void>;
     healthcheck(timeout?: number): Promise<boolean>;
     subscribe<T extends keyof SubscriptionToCallbackMap>(type: T, callback: SubscriptionToCallbackMap[T]): Subscription;
     get context(): StandardRollupContext;
@@ -536,6 +623,28 @@ declare class SolanaSignableRollup<RuntimeCall> {
      * Helper method to serialize a SolanaOffchainSpecCompliantMessage using borsh encoding.
      */
     private serializeSolanaSpecMessage;
+    /**
+     * Serializes a SolanaOffchainSimpleMultisigMessage using borsh encoding.
+     * Layout matches the Rust struct:
+     *   [u32 LE: wire_bytes.len][wire_bytes]
+     *   [32 bytes: chain_hash]
+     *   [u32 LE: signatures.len]
+     *     for each: [64 bytes: signature][32 bytes: pub_key]
+     *   [u32 LE: unused_pub_keys.len]
+     *     for each: [32 bytes: pub_key]
+     *   [u8: min_signers]
+     */
+    private serializeSolanaMultisigMessage;
+    /**
+     * Serializes a SolanaOffchainSpecCompliantMultisigMessage using borsh encoding.
+     * Layout matches the Rust struct:
+     *   [u32 LE: signed_message_with_preamble.len][signed_message_with_preamble]
+     *   [u32 LE: signatures.len]
+     *     for each: [64 bytes: signature]
+     *   [u32 LE: signer_bitfield]
+     *   [u8: min_signers]
+     */
+    private serializeSolanaSpecMultisigMessage;
 }
 declare function createSolanaSignableRollup<RuntimeCall>(rollupConfig?: Partial<RollupConfig<DeepPartial<StandardRollupContext>>>, solanaEndpoint?: string): Promise<SolanaSignableRollup<RuntimeCall>>;
 
@@ -559,4 +668,4 @@ declare class SchemaError extends SovereignError {
     constructor(message: string, reason: string, schema: object);
 }
 
-export { type Authenticator, type BaseTypeSpec, type CallParams, DEFAULT_TX_DETAILS, type Dedup, type EventPayload, InvalidRollupConfigError, Rollup, type RollupConfig, type RollupContext, type RollupTypeSpec, SchemaError, type SignerParams, type SimulateParams, type SolanaOffchainSimpleMessage, type SolanaOffchainSpecCompliantMessage, type SolanaOffchainUnsignedTransaction, SolanaSignableRollup, SovereignError, StandardRollup, type StandardRollupContext, type StandardRollupSpec, type Subscription, type TransactionContext, type TransactionResult, type TypeBuilder, type UnsignedTransactionContext, VersionMismatchError, addressFromPublicKey, createSolanaPreamble, createSolanaSignableRollup, createStandardRollup, standardTypeBuilder };
+export { type Authenticator, type BaseTypeSpec, type CallParams, DEFAULT_TX_DETAILS, type Dedup, type EventPayload, InvalidRollupConfigError, Rollup, type RollupConfig, type RollupContext, type RollupTypeSpec, SchemaError, type SignerParams, type SimulateParams, type SolanaMultisigAuthenticator, type SolanaMultisigSignParams, type SolanaMultisigSubmitParams, type SolanaOffchainSimpleMessage, type SolanaOffchainSimpleMultisigMessage, type SolanaOffchainSpecCompliantMessage, type SolanaOffchainSpecCompliantMultisigMessage, type SolanaOffchainUnsignedTransaction, type SolanaOffchainUnsignedTransactionV1, SolanaSignableRollup, SovereignError, StandardRollup, type StandardRollupContext, type StandardRollupSpec, type Subscription, type TransactionContext, type TransactionResult, type TypeBuilder, type UnsignedTransactionContext, VersionMismatchError, addressFromPublicKey, createSolanaSignableRollup, createStandardRollup, standardTypeBuilder };