@0xsequence/relayer 2.3.19 → 2.3.20

package/dist/declarations/src/index.d.ts

@@ -0,0 +1,42 @@
+import { ethers } from 'ethers';
+import { proto } from "./rpc-relayer/index.js";
+import { commons } from '@0xsequence/core';
+export interface Relayer {
+    simulate(wallet: string, ...transactions: commons.transaction.Transaction[]): Promise<SimulateResult[]>;
+    getFeeOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
+    getFeeOptionsRaw(entrypoint: string, data: ethers.BytesLike, options?: {
+        simulate?: boolean;
+    }): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
+    gasRefundOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<FeeOption[]>;
+    listGasSponsors(args: proto.ListGasSponsorsArgs): Promise<proto.ListGasSponsorsReturn>;
+    addGasSponsor(args: proto.AddGasSponsorArgs): Promise<proto.AddGasSponsorReturn>;
+    updateGasSponsor(args: proto.UpdateGasSponsorArgs): Promise<proto.UpdateGasSponsorReturn>;
+    removeGasSponsor(args: proto.RemoveGasSponsorArgs): Promise<proto.RemoveGasSponsorReturn>;
+    getNonce(address: string, space?: ethers.BigNumberish, blockTag?: ethers.BlockTag): Promise<ethers.BigNumberish>;
+    relay(signedTxs: commons.transaction.IntendedTransactionBundle, quote?: FeeQuote, waitForReceipt?: boolean, projectAccessKey?: string): Promise<commons.transaction.TransactionResponse>;
+    wait(metaTxnId: string | commons.transaction.SignedTransactionBundle, timeout?: number, delay?: number, maxFails?: number): Promise<commons.transaction.TransactionResponse>;
+    getMetaTransactions(projectId: number, page?: proto.Page): Promise<{
+        page: proto.Page;
+        transactions: proto.MetaTxnLog[];
+    }>;
+    getTransactionCost(projectId: number, from: string, to: string): Promise<{
+        cost: number;
+    }>;
+}
+export * from "./local-relayer.js";
+export * from "./provider-relayer.js";
+export * from "./rpc-relayer/index.js";
+export { proto as RpcRelayerProto } from "./rpc-relayer/index.js";
+export type SimulateResult = proto.SimulateResult;
+export type FeeOption = proto.FeeOption;
+export interface FeeQuote {
+    _tag: 'FeeQuote';
+    _quote: unknown;
+}
+export declare function isRelayer(cand: any): cand is Relayer;

package/dist/declarations/src/local-relayer.d.ts

@@ -0,0 +1,35 @@
+import { ethers } from 'ethers';
+import { FeeOption, FeeQuote, proto, Relayer } from "./index.js";
+import { ProviderRelayer, ProviderRelayerOptions } from "./provider-relayer.js";
+import { commons } from '@0xsequence/core';
+export type LocalRelayerOptions = Omit<ProviderRelayerOptions, 'provider'> & {
+    signer: ethers.Signer;
+};
+export declare function isLocalRelayerOptions(obj: any): obj is LocalRelayerOptions;
+export declare class LocalRelayer extends ProviderRelayer implements Relayer {
+    private signer;
+    private txnOptions;
+    constructor(options: LocalRelayerOptions | ethers.AbstractSigner);
+    getFeeOptions(_address: string, ..._transactions: commons.transaction.Transaction[]): Promise<{
+        options: FeeOption[];
+    }>;
+    getFeeOptionsRaw(_entrypoint: string, _data: ethers.BytesLike, _options?: {
+        simulate?: boolean;
+    }): Promise<{
+        options: FeeOption[];
+    }>;
+    gasRefundOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<FeeOption[]>;
+    setTransactionOptions(transactionRequest: ethers.TransactionRequest): void;
+    relay(signedTxs: commons.transaction.IntendedTransactionBundle, quote?: FeeQuote, waitForReceipt?: boolean): Promise<commons.transaction.TransactionResponse<ethers.TransactionReceipt>>;
+    getMetaTransactions(projectId: number, page?: proto.Page): Promise<{
+        page: proto.Page;
+        transactions: proto.MetaTxnLog[];
+    }>;
+    getTransactionCost(projectId: number, from: string, to: string): Promise<{
+        cost: number;
+    }>;
+    listGasSponsors(args: proto.ListGasSponsorsArgs): Promise<proto.ListGasSponsorsReturn>;
+    addGasSponsor(args: proto.AddGasSponsorArgs): Promise<proto.AddGasSponsorReturn>;
+    updateGasSponsor(args: proto.UpdateGasSponsorArgs): Promise<proto.UpdateGasSponsorReturn>;
+    removeGasSponsor(args: proto.RemoveGasSponsorArgs): Promise<proto.RemoveGasSponsorReturn>;
+}

package/dist/declarations/src/provider-relayer.d.ts

@@ -0,0 +1,47 @@
+import { ethers } from 'ethers';
+import { FeeOption, FeeQuote, proto, Relayer, SimulateResult } from "./index.js";
+import { Optionals } from '@0xsequence/utils';
+import { commons } from '@0xsequence/core';
+export interface ProviderRelayerOptions {
+    provider: ethers.Provider;
+    waitPollRate?: number;
+    deltaBlocksLog?: number;
+    fromBlockLog?: number;
+}
+export declare const ProviderRelayerDefaults: Required<Optionals<ProviderRelayerOptions>>;
+export declare function isProviderRelayerOptions(obj: any): obj is ProviderRelayerOptions;
+export declare abstract class ProviderRelayer implements Relayer {
+    provider: ethers.Provider;
+    waitPollRate: number;
+    deltaBlocksLog: number;
+    fromBlockLog: number;
+    constructor(options: ProviderRelayerOptions);
+    abstract getFeeOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
+    abstract getFeeOptionsRaw(entrypoint: string, data: ethers.BytesLike, options?: {
+        simulate?: boolean;
+    }): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
+    abstract gasRefundOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<FeeOption[]>;
+    abstract relay(signedTxs: commons.transaction.IntendedTransactionBundle, quote?: FeeQuote, waitForReceipt?: boolean): Promise<commons.transaction.TransactionResponse>;
+    abstract getTransactionCost(projectId: number, from: string, to: string): Promise<{
+        cost: number;
+    }>;
+    abstract getMetaTransactions(projectId: number, page?: proto.Page): Promise<{
+        page: proto.Page;
+        transactions: proto.MetaTxnLog[];
+    }>;
+    abstract listGasSponsors(args: proto.ListGasSponsorsArgs): Promise<proto.ListGasSponsorsReturn>;
+    abstract addGasSponsor(args: proto.AddGasSponsorArgs): Promise<proto.AddGasSponsorReturn>;
+    abstract updateGasSponsor(args: proto.UpdateGasSponsorArgs): Promise<proto.UpdateGasSponsorReturn>;
+    abstract removeGasSponsor(args: proto.RemoveGasSponsorArgs): Promise<proto.RemoveGasSponsorReturn>;
+    simulate(wallet: string, ...transactions: commons.transaction.Transaction[]): Promise<SimulateResult[]>;
+    getNonce(address: string, space?: ethers.BigNumberish, blockTag?: ethers.BlockTag): Promise<ethers.BigNumberish>;
+    wait(metaTxnId: string | commons.transaction.SignedTransactionBundle, timeoutDuration?: number, delay?: number, maxFails?: number): Promise<ethers.TransactionResponse & {
+        receipt: ethers.TransactionReceipt;
+    }>;
+}

package/dist/declarations/src/rpc-relayer/index.d.ts

@@ -0,0 +1,72 @@
+import { ethers } from 'ethers';
+import { FeeOption, FeeQuote, Relayer, SimulateResult } from "../index.js";
+import * as proto from "./relayer.gen.js";
+import { commons } from '@0xsequence/core';
+export { proto };
+export interface RpcRelayerOptions {
+    provider: ethers.AbstractProvider | {
+        url: string;
+    };
+    url: string;
+    projectAccessKey?: string;
+    jwtAuth?: string;
+}
+export declare function isRpcRelayerOptions(obj: any): obj is RpcRelayerOptions;
+export declare class RpcRelayer implements Relayer {
+    options: RpcRelayerOptions;
+    private readonly service;
+    readonly provider: ethers.Provider;
+    constructor(options: RpcRelayerOptions);
+    _fetch: (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+    waitReceipt(metaTxnId: string | commons.transaction.SignedTransactionBundle, delay?: number, maxFails?: number, isCancelled?: () => boolean): Promise<proto.GetMetaTxnReceiptReturn>;
+    simulate(wallet: string, ...transactions: commons.transaction.Transaction[]): Promise<SimulateResult[]>;
+    getFeeOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
+    getFeeOptionsRaw(entrypoint: string, data: ethers.BytesLike, options?: {
+        simulate?: boolean;
+        projectAccessKey?: string;
+    }): Promise<{
+        options: FeeOption[];
+        quote?: FeeQuote;
+    }>;
+    gasRefundOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<FeeOption[]>;
+    getNonce(address: string, space?: ethers.BigNumberish): Promise<ethers.BigNumberish>;
+    relay(signedTxs: commons.transaction.IntendedTransactionBundle, quote?: FeeQuote, waitForReceipt?: boolean, projectAccessKey?: string): Promise<commons.transaction.TransactionResponse<RelayerTxReceipt>>;
+    wait(metaTxnId: string | commons.transaction.SignedTransactionBundle, timeout?: number, delay?: number, maxFails?: number): Promise<commons.transaction.TransactionResponse<RelayerTxReceipt>>;
+    getMetaTransactions(projectId: number, page?: proto.Page): Promise<{
+        page: proto.Page;
+        transactions: proto.MetaTxnLog[];
+    }>;
+    getTransactionCost(projectId: number, from: string, to: string): Promise<{
+        cost: number;
+    }>;
+    listGasSponsors(args: proto.ListGasSponsorsArgs): Promise<proto.ListGasSponsorsReturn>;
+    addGasSponsor(args: proto.AddGasSponsorArgs): Promise<proto.AddGasSponsorReturn>;
+    updateGasSponsor(args: proto.UpdateGasSponsorArgs): Promise<proto.UpdateGasSponsorReturn>;
+    removeGasSponsor(args: proto.RemoveGasSponsorArgs): Promise<proto.RemoveGasSponsorReturn>;
+}
+export type RelayerTxReceipt = {
+    blockHash: string;
+    blockNumber: string;
+    contractAddress: string;
+    cumulativeGasUsed: string;
+    gasUsed: string;
+    logs: {
+        address: string;
+        blockHash: string;
+        blockNumber: string;
+        data: string;
+        logIndex: string;
+        removed: boolean;
+        topics: string[];
+        transactionHash: string;
+        transactionIndex: string;
+    }[];
+    logsBloom: string;
+    root: string;
+    status: string;
+    transactionHash: string;
+    transactionIndex: string;
+};