Class CustomerFeeTransferService

Transfers funds (currently only MOVEUSD) from a customer ledger account to the master CFX fee account

Hierarchy (View Summary)

CustomerFeeTransferQueryService
- CustomerFeeTransferService

Index

Constructors

constructor

new CustomerFeeTransferService(
    args: {
        db: B2bDatabase;
        internalEventPublisher: InternalEventPublisher;
        ledgerAccountService: LedgerAccountService;
        masterFeeLedgerAccountId: () => Promise<string>;
        temporalClient: TemporalWorkflowClient<Workflows>;
        transactionCacheBuster: TransactionCacheBuster;
    },
): CustomerFeeTransferService
Parameters
- args: {
      db: B2bDatabase;
      internalEventPublisher: InternalEventPublisher;
      ledgerAccountService: LedgerAccountService;
      masterFeeLedgerAccountId: () => Promise<string>;
      temporalClient: TemporalWorkflowClient<Workflows>;
      transactionCacheBuster: TransactionCacheBuster;
  }
  - db: B2bDatabase
  - internalEventPublisher: InternalEventPublisher
  - ledgerAccountService: LedgerAccountService
  - masterFeeLedgerAccountId: () => Promise<string>
    
    Read at each create.
  - temporalClient: TemporalWorkflowClient<Workflows>
  - transactionCacheBuster: TransactionCacheBuster
Returns CustomerFeeTransferService
Overrides CustomerFeeTransferQueryService.constructor
- Defined in fee-services/src/CustomerFeeTransferService.ts:153

Properties

`Protected` `Readonly`db

db: B2bDatabase

`Static`instance

instance: (...args: []) => CustomerFeeTransferService = ...

The process default: the master fee account and worker queue are read at each create.

Methods

create

create(
    __namedParameters: Pick<
        CustomerFeeTransfer,
        "description"
        | "sourceAccountId"
        | "targetAccountId"
        | "type",
    > & { customerId: string; senderMessage?: string; sourceAmount: BigNumber },
): Promise<
    | { ok: true; value: CustomerFeeTransfer }
    | {
        error:
            | ServiceError<"INVALID_TRANSFER" | "ENTITY_INACTIVE">
            | ServiceError<"INVALID_LEDGER_ACCOUNT", { ledgerAccountId: string }>;
        ok: false;
    },
>
Parameters
- __namedParameters: Pick<
      CustomerFeeTransfer,
      "description"
      | "sourceAccountId"
      | "targetAccountId"
      | "type",
  > & { customerId: string; senderMessage?: string; sourceAmount: BigNumber }
  - customerId: string
    
    Source wallet customer ID
  - OptionalsenderMessage?: string
  - sourceAmount: BigNumber
Returns Promise<
    | { ok: true; value: CustomerFeeTransfer }
    | {
        error:
            | ServiceError<"INVALID_TRANSFER" | "ENTITY_INACTIVE">
            | ServiceError<"INVALID_LEDGER_ACCOUNT", { ledgerAccountId: string }>;
        ok: false;
    },
>
- Defined in fee-services/src/CustomerFeeTransferService.ts:170

get

get(
__namedParameters: { customerId: string; id: string },
): Promise<{ ok: true; value: CustomerFeeTransfer | null }>
Parameters
- __namedParameters: { customerId: string; id: string }
Returns Promise<{ ok: true; value: CustomerFeeTransfer | null }>
Inherited from CustomerFeeTransferQueryService.get
- Defined in fee-services/src/CustomerFeeTransferService.ts:85

Class CustomerFeeTransferService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: B2bDatabase

internalEventPublisher: InternalEventPublisher

ledgerAccountService: LedgerAccountService

masterFeeLedgerAccountId: () => Promise<string>

temporalClient: TemporalWorkflowClient<Workflows>

transactionCacheBuster: TransactionCacheBuster

Returns CustomerFeeTransferService

Properties

`Protected` `Readonly`db

`Static`instance

Methods

create

Parameters

customerId: string

`Optional`senderMessage?: string

sourceAmount: BigNumber

Returns Promise<
    | { ok: true; value: CustomerFeeTransfer }
    | {
        error:
            | ServiceError<"INVALID_TRANSFER" | "ENTITY_INACTIVE">
            | ServiceError<"INVALID_LEDGER_ACCOUNT", { ledgerAccountId: string }>;
        ok: false;
    },
>

get

Parameters

Returns Promise<{ ok: true; value: CustomerFeeTransfer | null }>

Settings

On This Page

Class CustomerFeeTransferService

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

db: B2bDatabase

internalEventPublisher: InternalEventPublisher

ledgerAccountService: LedgerAccountService

masterFeeLedgerAccountId: () => Promise<string>

temporalClient: TemporalWorkflowClient<Workflows>

transactionCacheBuster: TransactionCacheBuster

Returns CustomerFeeTransferService

Properties

Protected Readonlydb

Staticinstance

Methods

create

Parameters

customerId: string

OptionalsenderMessage?: string

sourceAmount: BigNumber

Returns Promise< | { ok: true; value: CustomerFeeTransfer } | { error: | ServiceError<"INVALID_TRANSFER" | "ENTITY_INACTIVE"> | ServiceError<"INVALID_LEDGER_ACCOUNT", { ledgerAccountId: string }>; ok: false; },>

get

Parameters

Returns Promise<{ ok: true; value: CustomerFeeTransfer | null }>

Settings

On This Page

`Protected` `Readonly`db

`Static`instance

`Optional`senderMessage?: string

Returns Promise<
| { ok: true; value: CustomerFeeTransfer }
| {
error:
| ServiceError<"INVALID_TRANSFER" | "ENTITY_INACTIVE">
| ServiceError<"INVALID_LEDGER_ACCOUNT", { ledgerAccountId: string }>;
ok: false;
},
>