@0xsequence/relayer 2.3.39 → 3.0.0-beta.10

package/src/preconditions/types.ts

@@ -0,0 +1,201 @@
+import { Address } from 'ox'
+
+export interface Precondition {
+  type(): string
+  isValid(): Error | undefined
+}
+
+export class NativeBalancePrecondition implements Precondition {
+  constructor(
+    public readonly address: Address.Address,
+    public readonly min?: bigint,
+    public readonly max?: bigint,
+  ) {}
+
+  type(): string {
+    return 'native-balance'
+  }
+
+  isValid(): Error | undefined {
+    if (!this.address) {
+      return new Error('address is required')
+    }
+    if (this.min !== undefined && this.max !== undefined && this.min > this.max) {
+      return new Error('min balance cannot be greater than max balance')
+    }
+    return undefined
+  }
+}
+
+export class Erc20BalancePrecondition implements Precondition {
+  constructor(
+    public readonly address: Address.Address,
+    public readonly token: Address.Address,
+    public readonly min?: bigint,
+    public readonly max?: bigint,
+  ) {}
+
+  type(): string {
+    return 'erc20-balance'
+  }
+
+  isValid(): Error | undefined {
+    if (!this.address) {
+      return new Error('address is required')
+    }
+    if (!this.token) {
+      return new Error('token address is required')
+    }
+    if (this.min !== undefined && this.max !== undefined && this.min > this.max) {
+      return new Error('min balance cannot be greater than max balance')
+    }
+    return undefined
+  }
+}
+
+export class Erc20ApprovalPrecondition implements Precondition {
+  constructor(
+    public readonly address: Address.Address,
+    public readonly token: Address.Address,
+    public readonly operator: Address.Address,
+    public readonly min: bigint,
+  ) {}
+
+  type(): string {
+    return 'erc20-approval'
+  }
+
+  isValid(): Error | undefined {
+    if (!this.address) {
+      return new Error('address is required')
+    }
+    if (!this.token) {
+      return new Error('token address is required')
+    }
+    if (!this.operator) {
+      return new Error('operator address is required')
+    }
+    if (this.min === undefined) {
+      return new Error('min approval amount is required')
+    }
+    return undefined
+  }
+}
+
+export class Erc721OwnershipPrecondition implements Precondition {
+  constructor(
+    public readonly address: Address.Address,
+    public readonly token: Address.Address,
+    public readonly tokenId: bigint,
+    public readonly owned?: boolean,
+  ) {}
+
+  type(): string {
+    return 'erc721-ownership'
+  }
+
+  isValid(): Error | undefined {
+    if (!this.address) {
+      return new Error('address is required')
+    }
+    if (!this.token) {
+      return new Error('token address is required')
+    }
+    if (this.tokenId === undefined) {
+      return new Error('tokenId is required')
+    }
+    return undefined
+  }
+}
+
+export class Erc721ApprovalPrecondition implements Precondition {
+  constructor(
+    public readonly address: Address.Address,
+    public readonly token: Address.Address,
+    public readonly tokenId: bigint,
+    public readonly operator: Address.Address,
+  ) {}
+
+  type(): string {
+    return 'erc721-approval'
+  }
+
+  isValid(): Error | undefined {
+    if (!this.address) {
+      return new Error('address is required')
+    }
+    if (!this.token) {
+      return new Error('token address is required')
+    }
+    if (this.tokenId === undefined) {
+      return new Error('tokenId is required')
+    }
+    if (!this.operator) {
+      return new Error('operator address is required')
+    }
+    return undefined
+  }
+}
+
+export class Erc1155BalancePrecondition implements Precondition {
+  constructor(
+    public readonly address: Address.Address,
+    public readonly token: Address.Address,
+    public readonly tokenId: bigint,
+    public readonly min?: bigint,
+    public readonly max?: bigint,
+  ) {}
+
+  type(): string {
+    return 'erc1155-balance'
+  }
+
+  isValid(): Error | undefined {
+    if (!this.address) {
+      return new Error('address is required')
+    }
+    if (!this.token) {
+      return new Error('token address is required')
+    }
+    if (this.tokenId === undefined) {
+      return new Error('tokenId is required')
+    }
+    if (this.min !== undefined && this.max !== undefined && this.min > this.max) {
+      return new Error('min balance cannot be greater than max balance')
+    }
+    return undefined
+  }
+}
+
+export class Erc1155ApprovalPrecondition implements Precondition {
+  constructor(
+    public readonly address: Address.Address,
+    public readonly token: Address.Address,
+    public readonly tokenId: bigint,
+    public readonly operator: Address.Address,
+    public readonly min: bigint,
+  ) {}
+
+  type(): string {
+    return 'erc1155-approval'
+  }
+
+  isValid(): Error | undefined {
+    if (!this.address) {
+      return new Error('address is required')
+    }
+    if (!this.token) {
+      return new Error('token address is required')
+    }
+    if (this.tokenId === undefined) {
+      return new Error('tokenId is required')
+    }
+    if (!this.operator) {
+      return new Error('operator address is required')
+    }
+    if (this.min === undefined) {
+      return new Error('min approval amount is required')
+    }
+    return undefined
+  }
+}

package/src/relayer/index.ts

@@ -0,0 +1,60 @@
+import { Hex } from 'ox'
+import type { FeeToken, GetMetaTxnReceiptReturn } from './rpc-relayer/relayer.gen.js'
+
+export * from './rpc-relayer/index.js'
+export * from './standard/index.js'
+export * from './relayer.js'
+export type { FeeToken } from './rpc-relayer/relayer.gen.js'
+
+export interface FeeOption {
+  token: FeeToken
+  to: string
+  value: string
+  gasLimit: number
+}
+
+export interface FeeQuote {
+  _tag: 'FeeQuote'
+  _quote: unknown
+}
+
+export type OperationUnknownStatus = {
+  status: 'unknown'
+  reason?: string
+}
+
+export type OperationQueuedStatus = {
+  status: 'queued'
+  reason?: string
+}
+
+export type OperationPendingStatus = {
+  status: 'pending'
+  reason?: string
+}
+
+export type OperationPendingPreconditionStatus = {
+  status: 'pending-precondition'
+  reason?: string
+}
+
+export type OperationConfirmedStatus = {
+  status: 'confirmed'
+  transactionHash: Hex.Hex
+  data?: GetMetaTxnReceiptReturn
+}
+
+export type OperationFailedStatus = {
+  status: 'failed'
+  transactionHash?: Hex.Hex
+  reason: string
+  data?: GetMetaTxnReceiptReturn
+}
+
+export type OperationStatus =
+  | OperationUnknownStatus
+  | OperationQueuedStatus
+  | OperationPendingStatus
+  | OperationPendingPreconditionStatus
+  | OperationConfirmedStatus
+  | OperationFailedStatus

package/src/relayer/relayer.ts

@@ -0,0 +1,37 @@
+import { Address, Hex } from 'ox'
+import { FeeToken } from './rpc-relayer/relayer.gen.js'
+import { FeeOption, FeeQuote, OperationStatus } from './index.js'
+import { Payload, Precondition } from '@0xsequence/wallet-primitives'
+
+export interface Relayer {
+  kind: 'relayer'
+
+  type: string
+  id: string
+
+  isAvailable(wallet: Address.Address, chainId: number): Promise<boolean>
+
+  feeTokens(): Promise<{ isFeeRequired: boolean; tokens?: FeeToken[]; paymentAddress?: Address.Address }>
+
+  feeOptions(
+    wallet: Address.Address,
+    chainId: number,
+    calls: Payload.Call[],
+  ): Promise<{ options: FeeOption[]; quote?: FeeQuote }>
+
+  relay(to: Address.Address, data: Hex.Hex, chainId: number, quote?: FeeQuote): Promise<{ opHash: Hex.Hex }>
+
+  status(opHash: Hex.Hex, chainId: number): Promise<OperationStatus>
+
+  checkPrecondition(precondition: Precondition.Precondition): Promise<boolean>
+}
+
+export function isRelayer(relayer: any): relayer is Relayer {
+  return (
+    'isAvailable' in relayer &&
+    'feeOptions' in relayer &&
+    'relay' in relayer &&
+    'status' in relayer &&
+    'checkPrecondition' in relayer
+  )
+}