@sovereign-sdk/web3 0.0.13 → 0.0.15

package/dist/index.d.mts

@@ -86,6 +86,10 @@ type BaseTypeSpec = {
      * The type of runtime call used in the rollup.
      */
     RuntimeCall: any;
+    /**
+     * The type of the dedup data used to deduplicate transactions.
+     */
+    Dedup: any;
 };
 type OverrideType<Base, Override> = {
     [K in keyof Base]: K extends keyof Override ? Override[K] : Base[K];
@@ -137,46 +141,71 @@ type OverrideType<Base, Override> = {
  */
 type RollupTypeSpec<T extends Partial<BaseTypeSpec>> = OverrideType<BaseTypeSpec, T>;
 
+type DeepPartial<T> = T extends unknown[] ? T : T extends Record<string, unknown> ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+
+type UnsignedTransactionContext<S extends BaseTypeSpec, C extends RollupContext> = {
+    runtimeCall: S["RuntimeCall"];
+    sender: Uint8Array;
+    overrides: DeepPartial<S["UnsignedTransaction"]>;
+    rollup: Rollup<S, C>;
+};
+type TransactionContext<S extends BaseTypeSpec, C extends RollupContext> = {
+    unsignedTx: S["UnsignedTransaction"];
+    sender: Uint8Array;
+    signature: Uint8Array;
+    rollup: Rollup<S, C>;
+};
+type TypeBuilder<S extends BaseTypeSpec, C extends RollupContext> = {
+    unsignedTransaction: (context: UnsignedTransactionContext<S, C>) => Promise<S["UnsignedTransaction"]>;
+    transaction: (context: TransactionContext<S, C>) => Promise<S["Transaction"]>;
+};
 /**
- * The result of signing and submitting a transaction.
- *
- * @template Tx The type of the transaction
+ * Arbitrary context that is associated with the rollup.
  */
-type TransactionResult<Tx> = {
-    /**
-     * The response from the sequencer.
-     */
-    response: SovereignClient__default.Sequencer.TxCreateResponse;
-    /**
-     * The transaction that was submitted.
-     */
-    transaction: Tx;
-};
+type RollupContext = Record<string, unknown>;
 /**
  * The configuration for a rollup client.
  */
-type RollupConfig = {
+type RollupConfig<C extends RollupContext> = {
     /**
      * The base URL of the rollup full node API.
      */
     url?: string;
+    /**
+     * The Sovereign SDK client to use for the rollup.
+     * If not provided, the default client will be used using {@link RollupConfig.url}.
+     */
+    client?: SovereignClient__default;
     /**
      * The schema of the rollup.
      */
-    schema: RollupSchema;
+    schema?: RollupSchema;
     /**
-     * The default transaction details.
-     * This will be deprecated soon to remove Sovereign SDK specific types.
-     * @deprecated
-     * @private
+     * The serializer to use for the rollup.
+     * If not provided, a serializer will be created using the provided {@link RollupConfig.schema}.
      */
-    defaultTxDetails: TxDetails;
+    serializer?: RollupSerializer;
+    /**
+     * Arbitrary context that is associated with the rollup.
+     */
+    context: C;
 };
-type TxDetails = {
-    max_priority_fee_bips: number;
-    max_fee: number;
-    gas_limit?: number[];
-    chain_id: number;
+/**
+ * The result of signing and submitting a transaction.
+ *
+ * @template Tx The type of the transaction
+ */
+type TransactionResult<Tx> = {
+    /**
+     * The response from the sequencer.
+     */
+    response: SovereignClient__default.Sequencer.TxCreateResponse;
+    /**
+     * The transaction that was submitted.
+     */
+    transaction: Tx;
 };
 /**
  * The parameters for signing and submitting a transaction.
@@ -190,69 +219,58 @@ type SignerParams = {
 /**
  * The parameters for calling executing a runtime call transaction.
  */
-type CallParams = {
-    /**
-     * The transaction details to use for the call.
-     * @deprecated This will be removed soon to remove Sovereign SDK specific types.
-     *             In favor of a looser type specification.
-     */
-    txDetails?: TxDetails;
-} & SignerParams;
-/**
- * The parameters for simulating a runtime call transaction.
- */
-type SimulateParams = {
-    /**
-     * The transaction details to use for the simulation.
-     * @deprecated This will be removed soon to remove Sovereign SDK specific types.
-     *             In favor of a looser type specification.
-     */
-    txDetails: TxDetails;
+type CallParams<S extends BaseTypeSpec> = {
+    overrides?: DeepPartial<S["UnsignedTransaction"]>;
 } & SignerParams;
 /**
- * The rollup client.
+ * A generic rollup client.
  *
- * @template T - The type specification for the rollup.
+ * @template S - The type specification for the rollup.
  *               If not provided, the base type specification will be used which uses `any` for all types.
+ * @template C - The context for the rollup.
  */
-declare class StandardRollup<T extends BaseTypeSpec = BaseTypeSpec> {
+declare class Rollup<S extends BaseTypeSpec, C extends RollupContext> {
     private readonly _config;
     private readonly _client;
     private readonly _serializer;
+    private readonly _typeBuilder;
     /**
      * Creates a new rollup client.
      *
+     * @throws {@link InvalidRollupConfigError} - If no schema or serializer is provided.
+     *
      * @param config - The configuration for the rollup client.
+     * @param typeBuilder - The type builder for the rollup.
      */
-    constructor(config: RollupConfig);
+    constructor(config: RollupConfig<C>, typeBuilder: TypeBuilder<S, C>);
+    /**
+     * Retrieve dedup information about the provided address.
+     *
+     * @param address - The public key to dedup.
+     */
+    dedup(address: Uint8Array): Promise<S["Dedup"]>;
     /**
      * Submits a transaction to the rollup.
      *
      * @param transaction - The transaction to submit.
      */
-    submitTransaction(transaction: T["Transaction"]): Promise<SovereignClient__default.Sequencer.TxCreateResponse>;
+    submitTransaction(transaction: S["Transaction"]): Promise<SovereignClient__default.Sequencer.TxCreateResponse>;
     /**
      * Signs and submits a transaction to the rollup.
      * Utilizes the provided signer to sign the transaction.
      *
      * @param unsignedTx - The unsigned transaction to sign and submit.
+     * @param {SignerParams} params - The params for signing and submitting the transaction.
      */
-    signAndSubmitTransaction(unsignedTx: T["UnsignedTransaction"], { signer }: SignerParams): Promise<TransactionResult<T["Transaction"]>>;
+    signAndSubmitTransaction(unsignedTx: S["UnsignedTransaction"], { signer }: SignerParams): Promise<TransactionResult<S["Transaction"]>>;
     /**
      * Performs a runtime call transaction.
      * Utilizes the provided signer to sign the transaction.
      *
-     * @param runtimeMessage - The runtime message to call.
+     * @param runtimeCall - The runtime message to call.
+     * @param {CallParams<S>} params - The params for submitting a runtime call transaction.
      */
-    call(runtimeMessage: T["RuntimeCall"], { signer, txDetails }: CallParams): Promise<TransactionResult<T["Transaction"]>>;
-    /**
-     * Simulates a runtime call transaction.
-     *
-     * This method can be useful to estimate the gas cost of a runtime call transaction.
-     *
-     * @param runtimeMessage - The runtime message to call.
-     */
-    simulate(runtimeMessage: T["RuntimeCall"], { signer, txDetails }: SimulateParams): Promise<SovereignClient__default.Rollup.SimulateExecutionResponse>;
+    call(runtimeCall: S["RuntimeCall"], { signer, overrides }: CallParams<S>): Promise<TransactionResult<S["Transaction"]>>;
     /**
      * A ledger client that can be used to query the ledger.
      */
@@ -277,13 +295,73 @@ declare class StandardRollup<T extends BaseTypeSpec = BaseTypeSpec> {
      * See {@link RollupSerializer} for more information.
      */
     get serializer(): RollupSerializer;
+    /**
+     * The context for the rollup.
+     */
+    get context(): C;
 }
 
+type TxDetails = {
+    max_priority_fee_bips: number;
+    max_fee: number;
+    gas_limit?: number[];
+    chain_id: number;
+};
+type UnsignedTransaction = {
+    runtime_msg: Uint8Array;
+    nonce: number;
+    details: TxDetails;
+};
+type Transaction = {
+    pub_key: {
+        pub_key: Uint8Array;
+    };
+    signature: {
+        msg_sig: Uint8Array;
+    };
+} & UnsignedTransaction;
+type Dedup = {
+    nonce: number;
+};
+type StandardRollupContext = {
+    defaultTxDetails: TxDetails;
+};
+type StandardRollupSpec<RuntimeCall> = {
+    UnsignedTransaction: UnsignedTransaction;
+    Transaction: Transaction;
+    RuntimeCall: RuntimeCall;
+    Dedup: Dedup;
+};
+declare function standardTypeBuilder<S extends StandardRollupSpec<unknown>>(): TypeBuilder<S, StandardRollupContext>;
+/**
+ * The parameters for simulating a runtime call transaction.
+ */
+type SimulateParams = {
+    /**
+     * The transaction details to use for the simulation.
+     */
+    txDetails: TxDetails;
+    nonce?: number;
+} & SignerParams;
+declare class StandardRollup<RuntimeCall> extends Rollup<StandardRollupSpec<RuntimeCall>, StandardRollupContext> {
+    /**
+     * Simulates a runtime call transaction.
+     *
+     * This method can be useful to estimate the gas cost of a runtime call transaction.
+     *
+     * @param runtimeMessage - The runtime message to call.
+     */
+    simulate(runtimeMessage: StandardRollupSpec<RuntimeCall>["RuntimeCall"], { signer, txDetails, nonce: overrideNonce }: SimulateParams): Promise<SovereignClient__default.Rollup.SimulateExecutionResponse>;
+}
+declare function createStandardRollup<RuntimeCall, C extends StandardRollupContext = StandardRollupContext>(config: RollupConfig<C>, typeBuilderOverrides?: Partial<TypeBuilder<StandardRollupSpec<RuntimeCall>, C>>): StandardRollup<RuntimeCall>;
+
 /**
  * Base error class for Sovereign SDK Web3.
  */
 declare class SovereignError extends Error {
     constructor(message: string);
 }
+declare class InvalidRollupConfigError extends SovereignError {
+}
 
-export { type BaseTypeSpec, type CallParams, type RollupConfig, type RollupSchema, type RollupSerializer, type RollupTypeSpec, type SignerParams, type SimulateParams, SovereignError, StandardRollup, type TransactionResult, createSerializer };
+export { type BaseTypeSpec, type CallParams, type Dedup, InvalidRollupConfigError, Rollup, type RollupConfig, type RollupContext, type RollupSchema, type RollupSerializer, type RollupTypeSpec, type SignerParams, type SimulateParams, SovereignError, StandardRollup, type StandardRollupContext, type StandardRollupSpec, type Transaction, type TransactionContext, type TransactionResult, type TxDetails, type TypeBuilder, type UnsignedTransaction, type UnsignedTransactionContext, createSerializer, createStandardRollup, standardTypeBuilder };

package/dist/index.d.ts

@@ -86,6 +86,10 @@ type BaseTypeSpec = {
      * The type of runtime call used in the rollup.
      */
     RuntimeCall: any;
+    /**
+     * The type of the dedup data used to deduplicate transactions.
+     */
+    Dedup: any;
 };
 type OverrideType<Base, Override> = {
     [K in keyof Base]: K extends keyof Override ? Override[K] : Base[K];
@@ -137,46 +141,71 @@ type OverrideType<Base, Override> = {
  */
 type RollupTypeSpec<T extends Partial<BaseTypeSpec>> = OverrideType<BaseTypeSpec, T>;
 
+type DeepPartial<T> = T extends unknown[] ? T : T extends Record<string, unknown> ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+
+type UnsignedTransactionContext<S extends BaseTypeSpec, C extends RollupContext> = {
+    runtimeCall: S["RuntimeCall"];
+    sender: Uint8Array;
+    overrides: DeepPartial<S["UnsignedTransaction"]>;
+    rollup: Rollup<S, C>;
+};
+type TransactionContext<S extends BaseTypeSpec, C extends RollupContext> = {
+    unsignedTx: S["UnsignedTransaction"];
+    sender: Uint8Array;
+    signature: Uint8Array;
+    rollup: Rollup<S, C>;
+};
+type TypeBuilder<S extends BaseTypeSpec, C extends RollupContext> = {
+    unsignedTransaction: (context: UnsignedTransactionContext<S, C>) => Promise<S["UnsignedTransaction"]>;
+    transaction: (context: TransactionContext<S, C>) => Promise<S["Transaction"]>;
+};
 /**
- * The result of signing and submitting a transaction.
- *
- * @template Tx The type of the transaction
+ * Arbitrary context that is associated with the rollup.
  */
-type TransactionResult<Tx> = {
-    /**
-     * The response from the sequencer.
-     */
-    response: SovereignClient__default.Sequencer.TxCreateResponse;
-    /**
-     * The transaction that was submitted.
-     */
-    transaction: Tx;
-};
+type RollupContext = Record<string, unknown>;
 /**
  * The configuration for a rollup client.
  */
-type RollupConfig = {
+type RollupConfig<C extends RollupContext> = {
     /**
      * The base URL of the rollup full node API.
      */
     url?: string;
+    /**
+     * The Sovereign SDK client to use for the rollup.
+     * If not provided, the default client will be used using {@link RollupConfig.url}.
+     */
+    client?: SovereignClient__default;
     /**
      * The schema of the rollup.
      */
-    schema: RollupSchema;
+    schema?: RollupSchema;
     /**
-     * The default transaction details.
-     * This will be deprecated soon to remove Sovereign SDK specific types.
-     * @deprecated
-     * @private
+     * The serializer to use for the rollup.
+     * If not provided, a serializer will be created using the provided {@link RollupConfig.schema}.
      */
-    defaultTxDetails: TxDetails;
+    serializer?: RollupSerializer;
+    /**
+     * Arbitrary context that is associated with the rollup.
+     */
+    context: C;
 };
-type TxDetails = {
-    max_priority_fee_bips: number;
-    max_fee: number;
-    gas_limit?: number[];
-    chain_id: number;
+/**
+ * The result of signing and submitting a transaction.
+ *
+ * @template Tx The type of the transaction
+ */
+type TransactionResult<Tx> = {
+    /**
+     * The response from the sequencer.
+     */
+    response: SovereignClient__default.Sequencer.TxCreateResponse;
+    /**
+     * The transaction that was submitted.
+     */
+    transaction: Tx;
 };
 /**
  * The parameters for signing and submitting a transaction.
@@ -190,69 +219,58 @@ type SignerParams = {
 /**
  * The parameters for calling executing a runtime call transaction.
  */
-type CallParams = {
-    /**
-     * The transaction details to use for the call.
-     * @deprecated This will be removed soon to remove Sovereign SDK specific types.
-     *             In favor of a looser type specification.
-     */
-    txDetails?: TxDetails;
-} & SignerParams;
-/**
- * The parameters for simulating a runtime call transaction.
- */
-type SimulateParams = {
-    /**
-     * The transaction details to use for the simulation.
-     * @deprecated This will be removed soon to remove Sovereign SDK specific types.
-     *             In favor of a looser type specification.
-     */
-    txDetails: TxDetails;
+type CallParams<S extends BaseTypeSpec> = {
+    overrides?: DeepPartial<S["UnsignedTransaction"]>;
 } & SignerParams;
 /**
- * The rollup client.
+ * A generic rollup client.
  *
- * @template T - The type specification for the rollup.
+ * @template S - The type specification for the rollup.
  *               If not provided, the base type specification will be used which uses `any` for all types.
+ * @template C - The context for the rollup.
  */
-declare class StandardRollup<T extends BaseTypeSpec = BaseTypeSpec> {
+declare class Rollup<S extends BaseTypeSpec, C extends RollupContext> {
     private readonly _config;
     private readonly _client;
     private readonly _serializer;
+    private readonly _typeBuilder;
     /**
      * Creates a new rollup client.
      *
+     * @throws {@link InvalidRollupConfigError} - If no schema or serializer is provided.
+     *
      * @param config - The configuration for the rollup client.
+     * @param typeBuilder - The type builder for the rollup.
      */
-    constructor(config: RollupConfig);
+    constructor(config: RollupConfig<C>, typeBuilder: TypeBuilder<S, C>);
+    /**
+     * Retrieve dedup information about the provided address.
+     *
+     * @param address - The public key to dedup.
+     */
+    dedup(address: Uint8Array): Promise<S["Dedup"]>;
     /**
      * Submits a transaction to the rollup.
      *
      * @param transaction - The transaction to submit.
      */
-    submitTransaction(transaction: T["Transaction"]): Promise<SovereignClient__default.Sequencer.TxCreateResponse>;
+    submitTransaction(transaction: S["Transaction"]): Promise<SovereignClient__default.Sequencer.TxCreateResponse>;
     /**
      * Signs and submits a transaction to the rollup.
      * Utilizes the provided signer to sign the transaction.
      *
      * @param unsignedTx - The unsigned transaction to sign and submit.
+     * @param {SignerParams} params - The params for signing and submitting the transaction.
      */
-    signAndSubmitTransaction(unsignedTx: T["UnsignedTransaction"], { signer }: SignerParams): Promise<TransactionResult<T["Transaction"]>>;
+    signAndSubmitTransaction(unsignedTx: S["UnsignedTransaction"], { signer }: SignerParams): Promise<TransactionResult<S["Transaction"]>>;
     /**
      * Performs a runtime call transaction.
      * Utilizes the provided signer to sign the transaction.
      *
-     * @param runtimeMessage - The runtime message to call.
+     * @param runtimeCall - The runtime message to call.
+     * @param {CallParams<S>} params - The params for submitting a runtime call transaction.
      */
-    call(runtimeMessage: T["RuntimeCall"], { signer, txDetails }: CallParams): Promise<TransactionResult<T["Transaction"]>>;
-    /**
-     * Simulates a runtime call transaction.
-     *
-     * This method can be useful to estimate the gas cost of a runtime call transaction.
-     *
-     * @param runtimeMessage - The runtime message to call.
-     */
-    simulate(runtimeMessage: T["RuntimeCall"], { signer, txDetails }: SimulateParams): Promise<SovereignClient__default.Rollup.SimulateExecutionResponse>;
+    call(runtimeCall: S["RuntimeCall"], { signer, overrides }: CallParams<S>): Promise<TransactionResult<S["Transaction"]>>;
     /**
      * A ledger client that can be used to query the ledger.
      */
@@ -277,13 +295,73 @@ declare class StandardRollup<T extends BaseTypeSpec = BaseTypeSpec> {
      * See {@link RollupSerializer} for more information.
      */
     get serializer(): RollupSerializer;
+    /**
+     * The context for the rollup.
+     */
+    get context(): C;
 }
 
+type TxDetails = {
+    max_priority_fee_bips: number;
+    max_fee: number;
+    gas_limit?: number[];
+    chain_id: number;
+};
+type UnsignedTransaction = {
+    runtime_msg: Uint8Array;
+    nonce: number;
+    details: TxDetails;
+};
+type Transaction = {
+    pub_key: {
+        pub_key: Uint8Array;
+    };
+    signature: {
+        msg_sig: Uint8Array;
+    };
+} & UnsignedTransaction;
+type Dedup = {
+    nonce: number;
+};
+type StandardRollupContext = {
+    defaultTxDetails: TxDetails;
+};
+type StandardRollupSpec<RuntimeCall> = {
+    UnsignedTransaction: UnsignedTransaction;
+    Transaction: Transaction;
+    RuntimeCall: RuntimeCall;
+    Dedup: Dedup;
+};
+declare function standardTypeBuilder<S extends StandardRollupSpec<unknown>>(): TypeBuilder<S, StandardRollupContext>;
+/**
+ * The parameters for simulating a runtime call transaction.
+ */
+type SimulateParams = {
+    /**
+     * The transaction details to use for the simulation.
+     */
+    txDetails: TxDetails;
+    nonce?: number;
+} & SignerParams;
+declare class StandardRollup<RuntimeCall> extends Rollup<StandardRollupSpec<RuntimeCall>, StandardRollupContext> {
+    /**
+     * Simulates a runtime call transaction.
+     *
+     * This method can be useful to estimate the gas cost of a runtime call transaction.
+     *
+     * @param runtimeMessage - The runtime message to call.
+     */
+    simulate(runtimeMessage: StandardRollupSpec<RuntimeCall>["RuntimeCall"], { signer, txDetails, nonce: overrideNonce }: SimulateParams): Promise<SovereignClient__default.Rollup.SimulateExecutionResponse>;
+}
+declare function createStandardRollup<RuntimeCall, C extends StandardRollupContext = StandardRollupContext>(config: RollupConfig<C>, typeBuilderOverrides?: Partial<TypeBuilder<StandardRollupSpec<RuntimeCall>, C>>): StandardRollup<RuntimeCall>;
+
 /**
  * Base error class for Sovereign SDK Web3.
  */
 declare class SovereignError extends Error {
     constructor(message: string);
 }
+declare class InvalidRollupConfigError extends SovereignError {
+}
 
-export { type BaseTypeSpec, type CallParams, type RollupConfig, type RollupSchema, type RollupSerializer, type RollupTypeSpec, type SignerParams, type SimulateParams, SovereignError, StandardRollup, type TransactionResult, createSerializer };
+export { type BaseTypeSpec, type CallParams, type Dedup, InvalidRollupConfigError, Rollup, type RollupConfig, type RollupContext, type RollupSchema, type RollupSerializer, type RollupTypeSpec, type SignerParams, type SimulateParams, SovereignError, StandardRollup, type StandardRollupContext, type StandardRollupSpec, type Transaction, type TransactionContext, type TransactionResult, type TxDetails, type TypeBuilder, type UnsignedTransaction, type UnsignedTransactionContext, createSerializer, createStandardRollup, standardTypeBuilder };