Class MintingBackendModule

Index

Constructors

constructor

new MintingBackendModule(config): MintingBackendModule
Parameters
- config: MintingBackendModuleConfiguration
Returns MintingBackendModule
- Defined in packages/minting-backend/sdk/dist/types/index.d.ts:18

Methods

recordMint

recordMint(mintRequest): Promise<void>
Records a mint request in the persistence layer.
Parameters
- mintRequest: CreateMintRequest
  The mint request to be recorded
Returns Promise<void>
A promise that resolves when the mint request is recorded
- Defined in packages/minting-backend/sdk/dist/types/index.d.ts:24

submitMintingRequests

submitMintingRequests(config): Promise<void>
Submits minting requests for processing.
Parameters
- config: {
      defaultBatchSize?: number;
      chainName?: string;
      maxNumberOfTries?: number;
  }
  Configuration options for submitting minting requests
  - OptionaldefaultBatchSize?: number
    The number of minting requests to process in a batch
  - OptionalchainName?: string
    The blockchain network to process mints for
  - OptionalmaxNumberOfTries?: number
    Maximum number of retry attempts for failed requests
Returns Promise<void>
A promise that resolves when the minting requests are submitted
- Defined in packages/minting-backend/sdk/dist/types/index.d.ts:33

processMint

processMint(body, otherHandlers?): Promise<void>
Processes a mint webhook event.
Parameters
- body: string | Record<string, unknown>
  The webhook event payload
- OptionalotherHandlers: {
  zkevmMintRequestUpdated: ((event: ZkevmMintRequestUpdated) => Promise<void>);
  }
  Additional handlers for the webhook event
  - zkevmMintRequestUpdated: ((event: ZkevmMintRequestUpdated) => Promise<void>)
    - (event): Promise<void>
      Parameters
      event: ZkevmMintRequestUpdated
      Returns Promise<void>
Returns Promise<void>
A promise that resolves when the mint is processed
- Defined in packages/minting-backend/sdk/dist/types/index.d.ts:44