@cfxlabsinc/b2b-services
    Preparing search index...

    Class LedgerAccountTransferAdminService

    Hierarchy (View Summary)

    Index
    constructor
    db
    create get search update
    db: B2bDatabase

    • Parameters

      • __namedParameters: Pick<
            LedgerAccountTransfer,
            | "sourceLedgerAccountId"
            | "targetLedgerAccountId"
            | "sourceAmount"
            | "senderMessage",
        > & { idempotencyKey: string }
        • idempotencyKey: string

          Caller-supplied dedupe token (required — the service never mints its own; the caller owns idempotency). Submitting the same key twice returns the EXISTING transfer (no second insert, no workflow re-kick), making network-level retries safe.

          Stored in idempotency_key, which also seeds the on-chain Mintfx transfer PDA (read back by ledgerAccountTransferWorkflowActivities). Verified safe: mintfx-client's deterministicUUIDBytes hashes the key (sha256 → UUIDv5 → 16 bytes) before deriving the PDA seed, so length and charset are unconstrained.

      Returns Promise<
          | { ok: true; value: LedgerAccountTransfer }
          | { error: LedgerAccountTransferAdminCreateError; ok: false },
      >

    • Get a ledger account transfer by ID. Admin function does not lock down to a customer.

      Parameters

      • __namedParameters: { id: string }

      Returns Promise<
          {
              ok: true;
              value: | Omit<
                  {
                      createdAt: Date;
                      customerId: number;
                      data: {
                          fees: Fees;
                          senderMessage?: string;
                          sourceAmount: Amount;
                          targetAmount: Amount;
                          totalFees: Amount;
                      };
                      externalId: string;
                      id: number;
                      idempotencyKey: string;
                      identityId: number
                      | null;
                      organizationId: number | null;
                      productQuoteId: number;
                      receipt: { id: string; type: "SOLANA_TRANSACTION_SIGNATURE" } | null;
                      sourceLedgerAccountId: number;
                      status: "PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED";
                      targetLedgerAccountId: number;
                      updatedAt: Date;
                  },
                  | "id"
                  | "externalId"
                  | "customerId"
                  | "identityId"
                  | "organizationId"
                  | "data"
                  | "productQuoteId"
                  | "sourceLedgerAccountId"
                  | "targetLedgerAccountId",
              > & {
                  fees: (
                      {
                          amount: BigNumber;
                          receiver: "PROVIDER"
                          | "CFX"
                          | "CUSTOMER";
                          type: "FIXED" | "VARIABLE";
                      } & { currency: "MOVEUSD" }
                  )[];
                  id: string;
                  idempotencyKey: string;
                  productQuoteId: string;
                  senderMessage?: string;
                  sourceAmount: LedgerAccountTransferAmount;
                  sourceLedgerAccountId: string;
                  targetAmount: LedgerAccountTransferAmount;
                  targetLedgerAccountId: string;
                  totalFees: LedgerAccountTransferAmount;
              } & { sourceCustomerId: string; targetCustomerId: string }
              | null;
          },
      >

    • Parameters

      • __namedParameters: {
            createdAt?: DbTimestampCriteria;
            entityId?: string[];
            orderBy?: DbOrderByCriterion<
                Omit<
                    PgTableWithColumns<
                        {
                            columns: {
                                createdAt: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetHasDefault<SetNotNull<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                customerId: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                data: PgBuildColumn<
                                    "ledger_account_transfer",
                                    Set$Type<
                                        SetNotNull<(...)>,
                                        {
                                            fees: ...;
                                            senderMessage?: ...;
                                            sourceAmount: ...;
                                            targetAmount: ...;
                                            totalFees: ...;
                                        },
                                    >,
                                    {
                                        data: {
                                            fees: ...;
                                            senderMessage?: ...;
                                            sourceAmount: ...;
                                            targetAmount: ...;
                                            totalFees: ...;
                                        };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                externalId: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetHasRuntimeDefault<SetNotNull<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                id: PgBuildColumn<
                                    "ledger_account_transfer",
                                    HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: "byDefault";
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                idempotencyKey: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetNotNull<PgTextBuilder<(...)>>,
                                    {
                                        data: string;
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                identityId: PgBuildColumn<
                                    "ledger_account_transfer",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                organizationId: PgBuildColumn<
                                    "ledger_account_transfer",
                                    PgIntegerBuilder,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...)
                                        | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                productQuoteId: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                receipt: PgBuildColumn<
                                    "ledger_account_transfer",
                                    Set$Type<PgJsonbBuilder, { id: ...; type: ... }>,
                                    {
                                        data: { id: ...; type: ... };
                                        dataType: "object json";
                                        driverParam: unknown;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: false;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                sourceLedgerAccountId: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                status: PgBuildColumn<
                                    "ledger_account_transfer",
                                    Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                                    {
                                        data: (...) | (...) | (...) | (...);
                                        dataType: "string";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                targetLedgerAccountId: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetNotNull<PgIntegerBuilder>,
                                    {
                                        data: number;
                                        dataType: "number int32";
                                        driverParam: (...) | (...);
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: false;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                                updatedAt: PgBuildColumn<
                                    "ledger_account_transfer",
                                    SetHasDefault<SetHasDefault<(...)>>,
                                    {
                                        data: Date;
                                        dataType: "object date";
                                        driverParam: string;
                                        enumValues: undefined;
                                        generated: undefined;
                                        hasDefault: true;
                                        hasRuntimeDefault: false;
                                        identity: undefined;
                                        isAutoincrement: false;
                                        isPrimaryKey: false;
                                        name: string;
                                        notNull: true;
                                        tableName: "ledger_account_transfer";
                                    },
                                >;
                            };
                            dialect: "pg";
                            name: "ledger_account_transfer";
                            schema: "b2b";
                        },
                    >,
                    "enableRLS",
                >,
                "createdAt"
                | "updatedAt",
            >[];
            page?: number;
            pageSize?: number;
            sourceCustomerId?: string;
            sourceLedgerAccountId?: string[];
            status?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[];
            targetCustomerId?: string;
            targetLedgerAccountId?: string[];
            updatedAt?: DbTimestampCriteria;
        }
        • OptionalcreatedAt?: DbTimestampCriteria
        • OptionalentityId?: string[]
        • OptionalorderBy?: DbOrderByCriterion<
              Omit<
                  PgTableWithColumns<
                      {
                          columns: {
                              createdAt: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetHasDefault<SetNotNull<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              customerId: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              data: PgBuildColumn<
                                  "ledger_account_transfer",
                                  Set$Type<
                                      SetNotNull<(...)>,
                                      {
                                          fees: ...;
                                          senderMessage?: ...;
                                          sourceAmount: ...;
                                          targetAmount: ...;
                                          totalFees: ...;
                                      },
                                  >,
                                  {
                                      data: {
                                          fees: ...;
                                          senderMessage?: ...;
                                          sourceAmount: ...;
                                          targetAmount: ...;
                                          totalFees: ...;
                                      };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              externalId: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetHasRuntimeDefault<SetNotNull<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              id: PgBuildColumn<
                                  "ledger_account_transfer",
                                  HasIdentity<SetIsPrimaryKey<(...)>, "byDefault">,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: "byDefault";
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              idempotencyKey: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetNotNull<PgTextBuilder<(...)>>,
                                  {
                                      data: string;
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              identityId: PgBuildColumn<
                                  "ledger_account_transfer",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              organizationId: PgBuildColumn<
                                  "ledger_account_transfer",
                                  PgIntegerBuilder,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...)
                                      | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              productQuoteId: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              receipt: PgBuildColumn<
                                  "ledger_account_transfer",
                                  Set$Type<PgJsonbBuilder, { id: ...; type: ... }>,
                                  {
                                      data: { id: ...; type: ... };
                                      dataType: "object json";
                                      driverParam: unknown;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: false;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              sourceLedgerAccountId: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              status: PgBuildColumn<
                                  "ledger_account_transfer",
                                  Set$Type<SetNotNull<(...)>, (...) | (...) | (...) | (...)>,
                                  {
                                      data: (...) | (...) | (...) | (...);
                                      dataType: "string";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              targetLedgerAccountId: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetNotNull<PgIntegerBuilder>,
                                  {
                                      data: number;
                                      dataType: "number int32";
                                      driverParam: (...) | (...);
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: false;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                              updatedAt: PgBuildColumn<
                                  "ledger_account_transfer",
                                  SetHasDefault<SetHasDefault<(...)>>,
                                  {
                                      data: Date;
                                      dataType: "object date";
                                      driverParam: string;
                                      enumValues: undefined;
                                      generated: undefined;
                                      hasDefault: true;
                                      hasRuntimeDefault: false;
                                      identity: undefined;
                                      isAutoincrement: false;
                                      isPrimaryKey: false;
                                      name: string;
                                      notNull: true;
                                      tableName: "ledger_account_transfer";
                                  },
                              >;
                          };
                          dialect: "pg";
                          name: "ledger_account_transfer";
                          schema: "b2b";
                      },
                  >,
                  "enableRLS",
              >,
              "createdAt"
              | "updatedAt",
          >[]
        • Optionalpage?: number

          Defaults to 1

        • OptionalpageSize?: number

          Defaults to 10

        • OptionalsourceCustomerId?: string
        • OptionalsourceLedgerAccountId?: string[]
        • Optionalstatus?: ("PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED")[]
        • OptionaltargetCustomerId?: string
        • OptionaltargetLedgerAccountId?: string[]
        • OptionalupdatedAt?: DbTimestampCriteria

      Returns Promise<
          {
              ok: true;
              value: (
                  Omit<
                      {
                          createdAt: Date;
                          customerId: number;
                          data: {
                              fees: Fees;
                              senderMessage?: string;
                              sourceAmount: Amount;
                              targetAmount: Amount;
                              totalFees: Amount;
                          };
                          externalId: string;
                          id: number;
                          idempotencyKey: string;
                          identityId: number
                          | null;
                          organizationId: number | null;
                          productQuoteId: number;
                          receipt: { id: string; type: "SOLANA_TRANSACTION_SIGNATURE" } | null;
                          sourceLedgerAccountId: number;
                          status: "PENDING" | "FAILED" | "CANCELLED" | "SUCCEEDED";
                          targetLedgerAccountId: number;
                          updatedAt: Date;
                      },
                      | "id"
                      | "externalId"
                      | "customerId"
                      | "identityId"
                      | "organizationId"
                      | "data"
                      | "productQuoteId"
                      | "sourceLedgerAccountId"
                      | "targetLedgerAccountId",
                  > & {
                      fees: (
                          {
                              amount: BigNumber;
                              receiver: "PROVIDER"
                              | "CFX"
                              | "CUSTOMER";
                              type: "FIXED" | "VARIABLE";
                          } & { currency: "MOVEUSD" }
                      )[];
                      id: string;
                      idempotencyKey: string;
                      productQuoteId: string;
                      senderMessage?: string;
                      sourceAmount: LedgerAccountTransferAmount;
                      sourceLedgerAccountId: string;
                      targetAmount: LedgerAccountTransferAmount;
                      targetLedgerAccountId: string;
                      totalFees: LedgerAccountTransferAmount;
                  } & { entityId: string }
              )[];
          },
      >

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods