@0xsequence/relayer 2.2.9 → 2.2.11

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

@@ -1,6 +1,16 @@
+export declare const WebrpcHeader = "Webrpc";
+export declare const WebrpcHeaderValue = "webrpc@v0.22.0;gen-typescript@v0.16.1;sequence-relayer@v0.4.1";
 export declare const WebRPCVersion = "v1";
 export declare const WebRPCSchemaVersion = "v0.4.1";
-export declare const WebRPCSchemaHash = "dd95e21fa884c6564199bc3dd5f588534827ffe2";
+export declare const WebRPCSchemaHash = "9c42435ea10493aecdfbbecb2be284b8dd721539";
+type WebrpcGenVersions = {
+    webrpcGenVersion: string;
+    codeGenName: string;
+    codeGenVersion: string;
+    schemaName: string;
+    schemaVersion: string;
+};
+export declare function VersionFromHeader(headers: Headers): WebrpcGenVersions;
 export declare enum ETHTxnStatus {
     UNKNOWN = "UNKNOWN",
     DROPPED = "DROPPED",
@@ -136,6 +146,7 @@ export interface MetaTxnLog {
     gasFeeMarkup?: number;
     usdRate: string;
     creditsUsed: number;
+    cost: string;
     isWhitelisted: boolean;
     gasSponsor?: number;
     gasTank?: number;
@@ -241,17 +252,16 @@ export interface Relayer {
     getGasTank(args: GetGasTankArgs, headers?: object, signal?: AbortSignal): Promise<GetGasTankReturn>;
     addGasTank(args: AddGasTankArgs, headers?: object, signal?: AbortSignal): Promise<AddGasTankReturn>;
     updateGasTank(args: UpdateGasTankArgs, headers?: object, signal?: AbortSignal): Promise<UpdateGasTankReturn>;
-    getGasSponsor(args: GetGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<GetGasSponsorReturn>;
-    addressGasSponsors(args: AddressGasSponsorsArgs, headers?: object, signal?: AbortSignal): Promise<AddressGasSponsorsReturn>;
-    listGasSponsors(args: ListGasSponsorsArgs, headers?: object, signal?: AbortSignal): Promise<ListGasSponsorsReturn>;
-    addGasSponsor(args: AddGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<AddGasSponsorReturn>;
-    updateGasSponsor(args: UpdateGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<UpdateGasSponsorReturn>;
-    removeGasSponsor(args: RemoveGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<RemoveGasSponsorReturn>;
-    reportGasSponsorUsage(args: ReportGasSponsorUsageArgs, headers?: object, signal?: AbortSignal): Promise<ReportGasSponsorUsageReturn>;
     nextGasTankBalanceAdjustmentNonce(args: NextGasTankBalanceAdjustmentNonceArgs, headers?: object, signal?: AbortSignal): Promise<NextGasTankBalanceAdjustmentNonceReturn>;
     adjustGasTankBalance(args: AdjustGasTankBalanceArgs, headers?: object, signal?: AbortSignal): Promise<AdjustGasTankBalanceReturn>;
     getGasTankBalanceAdjustment(args: GetGasTankBalanceAdjustmentArgs, headers?: object, signal?: AbortSignal): Promise<GetGasTankBalanceAdjustmentReturn>;
     listGasTankBalanceAdjustments(args: ListGasTankBalanceAdjustmentsArgs, headers?: object, signal?: AbortSignal): Promise<ListGasTankBalanceAdjustmentsReturn>;
+    listGasSponsors(args: ListGasSponsorsArgs, headers?: object, signal?: AbortSignal): Promise<ListGasSponsorsReturn>;
+    getGasSponsor(args: GetGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<GetGasSponsorReturn>;
+    addGasSponsor(args: AddGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<AddGasSponsorReturn>;
+    updateGasSponsor(args: UpdateGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<UpdateGasSponsorReturn>;
+    removeGasSponsor(args: RemoveGasSponsorArgs, headers?: object, signal?: AbortSignal): Promise<RemoveGasSponsorReturn>;
+    addressGasSponsors(args: AddressGasSponsorsArgs, headers?: object, signal?: AbortSignal): Promise<AddressGasSponsorsReturn>;
     getProjectBalance(args: GetProjectBalanceArgs, headers?: object, signal?: AbortSignal): Promise<GetProjectBalanceReturn>;
     adjustProjectBalance(args: AdjustProjectBalanceArgs, headers?: object, signal?: AbortSignal): Promise<AdjustProjectBalanceReturn>;
 }
@@ -397,32 +407,53 @@ export interface UpdateGasTankReturn {
     status: boolean;
     gasTank: GasTank;
 }
-export interface GetGasSponsorArgs {
+export interface NextGasTankBalanceAdjustmentNonceArgs {
     id: number;
 }
-export interface GetGasSponsorReturn {
-    gasSponsor: GasSponsor;
+export interface NextGasTankBalanceAdjustmentNonceReturn {
+    nonce: number;
 }
-export interface AddressGasSponsorsArgs {
-    address: string;
+export interface AdjustGasTankBalanceArgs {
+    id: number;
+    nonce: number;
+    amount: number;
+}
+export interface AdjustGasTankBalanceReturn {
+    status: boolean;
+    adjustment: GasTankBalanceAdjustment;
+}
+export interface GetGasTankBalanceAdjustmentArgs {
+    id: number;
+    nonce: number;
+}
+export interface GetGasTankBalanceAdjustmentReturn {
+    adjustment: GasTankBalanceAdjustment;
+}
+export interface ListGasTankBalanceAdjustmentsArgs {
+    id: number;
     page?: Page;
 }
-export interface AddressGasSponsorsReturn {
+export interface ListGasTankBalanceAdjustmentsReturn {
     page: Page;
-    gasSponsors: Array<GasSponsor>;
+    adjustments: Array<GasTankBalanceAdjustment>;
 }
 export interface ListGasSponsorsArgs {
     projectId: number;
-    gasTankId: number;
     page?: Page;
 }
 export interface ListGasSponsorsReturn {
     page: Page;
     gasSponsors: Array<GasSponsor>;
 }
+export interface GetGasSponsorArgs {
+    projectId: number;
+    id: number;
+}
+export interface GetGasSponsorReturn {
+    gasSponsor: GasSponsor;
+}
 export interface AddGasSponsorArgs {
     projectId: number;
-    gasTankId: number;
     address: string;
     name?: string;
     active?: boolean;
@@ -432,6 +463,7 @@ export interface AddGasSponsorReturn {
     gasSponsor: GasSponsor;
 }
 export interface UpdateGasSponsorArgs {
+    projectId: number;
     id: number;
     name?: string;
     active?: boolean;
@@ -441,49 +473,19 @@ export interface UpdateGasSponsorReturn {
     gasSponsor: GasSponsor;
 }
 export interface RemoveGasSponsorArgs {
-    id: number;
-}
-export interface RemoveGasSponsorReturn {
-    status: boolean;
-}
-export interface ReportGasSponsorUsageArgs {
     projectId: number;
-    gasTankId: number;
-    startTime?: string;
-    endTime?: string;
-}
-export interface ReportGasSponsorUsageReturn {
-    gasSponsorUsage: Array<GasSponsorUsage>;
-}
-export interface NextGasTankBalanceAdjustmentNonceArgs {
-    id: number;
-}
-export interface NextGasTankBalanceAdjustmentNonceReturn {
-    nonce: number;
-}
-export interface AdjustGasTankBalanceArgs {
     id: number;
-    nonce: number;
-    amount: number;
 }
-export interface AdjustGasTankBalanceReturn {
+export interface RemoveGasSponsorReturn {
     status: boolean;
-    adjustment: GasTankBalanceAdjustment;
-}
-export interface GetGasTankBalanceAdjustmentArgs {
-    id: number;
-    nonce: number;
-}
-export interface GetGasTankBalanceAdjustmentReturn {
-    adjustment: GasTankBalanceAdjustment;
 }
-export interface ListGasTankBalanceAdjustmentsArgs {
-    id: number;
+export interface AddressGasSponsorsArgs {
+    address: string;
     page?: Page;
 }
-export interface ListGasTankBalanceAdjustmentsReturn {
+export interface AddressGasSponsorsReturn {
     page: Page;
-    adjustments: Array<GasTankBalanceAdjustment>;
+    gasSponsors: Array<GasSponsor>;
 }
 export interface GetProjectBalanceArgs {
     projectId: number;
@@ -525,17 +527,16 @@ export declare class Relayer implements Relayer {
     getGasTank: (args: GetGasTankArgs, headers?: object, signal?: AbortSignal) => Promise<GetGasTankReturn>;
     addGasTank: (args: AddGasTankArgs, headers?: object, signal?: AbortSignal) => Promise<AddGasTankReturn>;
     updateGasTank: (args: UpdateGasTankArgs, headers?: object, signal?: AbortSignal) => Promise<UpdateGasTankReturn>;
-    getGasSponsor: (args: GetGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<GetGasSponsorReturn>;
-    addressGasSponsors: (args: AddressGasSponsorsArgs, headers?: object, signal?: AbortSignal) => Promise<AddressGasSponsorsReturn>;
-    listGasSponsors: (args: ListGasSponsorsArgs, headers?: object, signal?: AbortSignal) => Promise<ListGasSponsorsReturn>;
-    addGasSponsor: (args: AddGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<AddGasSponsorReturn>;
-    updateGasSponsor: (args: UpdateGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<UpdateGasSponsorReturn>;
-    removeGasSponsor: (args: RemoveGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<RemoveGasSponsorReturn>;
-    reportGasSponsorUsage: (args: ReportGasSponsorUsageArgs, headers?: object, signal?: AbortSignal) => Promise<ReportGasSponsorUsageReturn>;
     nextGasTankBalanceAdjustmentNonce: (args: NextGasTankBalanceAdjustmentNonceArgs, headers?: object, signal?: AbortSignal) => Promise<NextGasTankBalanceAdjustmentNonceReturn>;
     adjustGasTankBalance: (args: AdjustGasTankBalanceArgs, headers?: object, signal?: AbortSignal) => Promise<AdjustGasTankBalanceReturn>;
     getGasTankBalanceAdjustment: (args: GetGasTankBalanceAdjustmentArgs, headers?: object, signal?: AbortSignal) => Promise<GetGasTankBalanceAdjustmentReturn>;
     listGasTankBalanceAdjustments: (args: ListGasTankBalanceAdjustmentsArgs, headers?: object, signal?: AbortSignal) => Promise<ListGasTankBalanceAdjustmentsReturn>;
+    listGasSponsors: (args: ListGasSponsorsArgs, headers?: object, signal?: AbortSignal) => Promise<ListGasSponsorsReturn>;
+    getGasSponsor: (args: GetGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<GetGasSponsorReturn>;
+    addGasSponsor: (args: AddGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<AddGasSponsorReturn>;
+    updateGasSponsor: (args: UpdateGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<UpdateGasSponsorReturn>;
+    removeGasSponsor: (args: RemoveGasSponsorArgs, headers?: object, signal?: AbortSignal) => Promise<RemoveGasSponsorReturn>;
+    addressGasSponsors: (args: AddressGasSponsorsArgs, headers?: object, signal?: AbortSignal) => Promise<AddressGasSponsorsReturn>;
     getProjectBalance: (args: GetProjectBalanceArgs, headers?: object, signal?: AbortSignal) => Promise<GetProjectBalanceReturn>;
     adjustProjectBalance: (args: AdjustProjectBalanceArgs, headers?: object, signal?: AbortSignal) => Promise<AdjustProjectBalanceReturn>;
 }
@@ -589,6 +590,9 @@ export declare class UnauthorizedError extends WebrpcError {
 export declare class PermissionDeniedError extends WebrpcError {
     constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
 }
+export declare class SessionExpiredError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
 export declare class MethodNotFoundError extends WebrpcError {
     constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
 }
@@ -601,6 +605,45 @@ export declare class AbortedError extends WebrpcError {
 export declare class GeoblockedError extends WebrpcError {
     constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
 }
+export declare class RateLimitedError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class ProjectNotFoundError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class AccessKeyNotFoundError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class AccessKeyMismatchError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class InvalidOriginError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class InvalidServiceError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class UnauthorizedUserError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class QuotaExceededError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class QuotaRateLimitError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class NoDefaultKeyError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class MaxAccessKeysError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class AtLeastOneKeyError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
+export declare class TimeoutError extends WebrpcError {
+    constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
+}
 export declare class InvalidArgumentError extends WebrpcError {
     constructor(name?: string, code?: number, message?: string, status?: number, cause?: string);
 }
@@ -630,14 +673,70 @@ export declare enum errors {
     WebrpcStreamFinished = "WebrpcStreamFinished",
     Unauthorized = "Unauthorized",
     PermissionDenied = "PermissionDenied",
+    SessionExpired = "SessionExpired",
     MethodNotFound = "MethodNotFound",
     RequestConflict = "RequestConflict",
     Aborted = "Aborted",
     Geoblocked = "Geoblocked",
+    RateLimited = "RateLimited",
+    ProjectNotFound = "ProjectNotFound",
+    AccessKeyNotFound = "AccessKeyNotFound",
+    AccessKeyMismatch = "AccessKeyMismatch",
+    InvalidOrigin = "InvalidOrigin",
+    InvalidService = "InvalidService",
+    UnauthorizedUser = "UnauthorizedUser",
+    QuotaExceeded = "QuotaExceeded",
+    QuotaRateLimit = "QuotaRateLimit",
+    NoDefaultKey = "NoDefaultKey",
+    MaxAccessKeys = "MaxAccessKeys",
+    AtLeastOneKey = "AtLeastOneKey",
+    Timeout = "Timeout",
     InvalidArgument = "InvalidArgument",
     Unavailable = "Unavailable",
     QueryFailed = "QueryFailed",
     NotFound = "NotFound",
     InsufficientFee = "InsufficientFee"
 }
+export declare enum WebrpcErrorCodes {
+    WebrpcEndpoint = 0,
+    WebrpcRequestFailed = -1,
+    WebrpcBadRoute = -2,
+    WebrpcBadMethod = -3,
+    WebrpcBadRequest = -4,
+    WebrpcBadResponse = -5,
+    WebrpcServerPanic = -6,
+    WebrpcInternalError = -7,
+    WebrpcClientDisconnected = -8,
+    WebrpcStreamLost = -9,
+    WebrpcStreamFinished = -10,
+    Unauthorized = 1000,
+    PermissionDenied = 1001,
+    SessionExpired = 1002,
+    MethodNotFound = 1003,
+    RequestConflict = 1004,
+    Aborted = 1005,
+    Geoblocked = 1006,
+    RateLimited = 1007,
+    ProjectNotFound = 1008,
+    AccessKeyNotFound = 1101,
+    AccessKeyMismatch = 1102,
+    InvalidOrigin = 1103,
+    InvalidService = 1104,
+    UnauthorizedUser = 1105,
+    QuotaExceeded = 1200,
+    QuotaRateLimit = 1201,
+    NoDefaultKey = 1300,
+    MaxAccessKeys = 1301,
+    AtLeastOneKey = 1302,
+    Timeout = 1900,
+    InvalidArgument = 2001,
+    Unavailable = 2002,
+    QueryFailed = 2003,
+    NotFound = 3000,
+    InsufficientFee = 3004
+}
+export declare const webrpcErrorByCode: {
+    [code: number]: any;
+};
 export type Fetch = (input: RequestInfo, init?: RequestInit) => Promise<Response>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/relayer",
-  "version": "2.2.9",
+  "version": "2.2.11",
   "description": "relayer sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/relayer",
   "source": "src/index.ts",
@@ -12,15 +12,15 @@
     "ethers": ">=6"
   },
   "dependencies": {
-    "@0xsequence/abi": "2.2.9",
-    "@0xsequence/core": "2.2.9",
-    "@0xsequence/utils": "2.2.9"
+    "@0xsequence/abi": "2.2.11",
+    "@0xsequence/core": "2.2.11",
+    "@0xsequence/utils": "2.2.11"
   },
   "devDependencies": {
     "@0xsequence/wallet-contracts": "^3.0.1",
     "ethers": "6.13.4",
-    "@0xsequence/signhub": "2.2.9",
-    "@0xsequence/tests": "2.2.9"
+    "@0xsequence/tests": "2.2.11",
+    "@0xsequence/signhub": "2.2.11"
   },
   "files": [
     "src",

package/src/index.ts

@@ -29,6 +29,12 @@ export interface Relayer {
   // relayer for submitting your transaction to a network.
   gasRefundOptions(address: string, ...transactions: commons.transaction.Transaction[]): Promise<FeeOption[]>
 
+  // Gas tank sponsorship management
+  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 returns the transaction count/nonce for a wallet, encoded with nonce space.
   // If space is undefined, the relayer can choose a nonce space to encode the result with.
   // Otherwise, the relayer must return a nonce encoded for the given nonce space.

package/src/local-relayer.ts

@@ -96,6 +96,22 @@ export class LocalRelayer extends ProviderRelayer implements Relayer {
   }> {
     return { cost: 0 }
   }
+
+  async listGasSponsors(args: proto.ListGasSponsorsArgs): Promise<proto.ListGasSponsorsReturn> {
+    return { page: { page: 0, pageSize: 100 }, gasSponsors: [] }
+  }
+
+  async addGasSponsor(args: proto.AddGasSponsorArgs): Promise<proto.AddGasSponsorReturn> {
+    return { status: true, gasSponsor: {} as proto.GasSponsor }
+  }
+
+  async updateGasSponsor(args: proto.UpdateGasSponsorArgs): Promise<proto.UpdateGasSponsorReturn> {
+    return { status: true, gasSponsor: {} as proto.GasSponsor }
+  }
+
+  async removeGasSponsor(args: proto.RemoveGasSponsorArgs): Promise<proto.RemoveGasSponsorReturn> {
+    return { status: true }
+  }
 }
 
 function isAbstractSigner(signer: any): signer is ethers.AbstractSigner {

package/src/provider-relayer.ts

@@ -75,6 +75,14 @@ export abstract class ProviderRelayer implements Relayer {
     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>
+
   async simulate(wallet: string, ...transactions: commons.transaction.Transaction[]): Promise<SimulateResult[]> {
     return (
       await Promise.all(

package/src/rpc-relayer/index.ts

@@ -324,6 +324,22 @@ export class RpcRelayer implements Relayer {
   }> {
     return this.service.getTransactionCost({ projectId, from, to })
   }
+
+  async listGasSponsors(args: proto.ListGasSponsorsArgs): Promise<proto.ListGasSponsorsReturn> {
+    return this.service.listGasSponsors(args)
+  }
+
+  async addGasSponsor(args: proto.AddGasSponsorArgs): Promise<proto.AddGasSponsorReturn> {
+    return this.service.addGasSponsor(args)
+  }
+
+  async updateGasSponsor(args: proto.UpdateGasSponsorArgs): Promise<proto.UpdateGasSponsorReturn> {
+    return this.service.updateGasSponsor(args)
+  }
+
+  async removeGasSponsor(args: proto.RemoveGasSponsorArgs): Promise<proto.RemoveGasSponsorReturn> {
+    return this.service.removeGasSponsor(args)
+  }
 }
 
 class MetaTransactionResponseException {