Class Credit

Concrete implementation of ICredit for managing financial credit transactions.

Implements

ICredit

Index

Constructors

Methods

getAccountCredited getAccountDebited getFromProcess getId getTokenBalance getTransactionDate toString fromCreditNotice

Constructors

constructor

new Credit(params: CreditConstructorParams): Credit
Creates a new Credit instance.
Parameters
- params: CreditConstructorParams
  Constructor parameters containing all credit information
Returns Credit
- Defined in models/financial/credit/Credit.ts:58

Methods

getAccountCredited

getAccountCredited(): string
Gets the account that was credited

Returns string
The address/ID of the credited account
Implementation of ICredit.getAccountCredited
- Defined in models/financial/credit/Credit.ts:94

getAccountDebited

getAccountDebited(): string
Gets the account that was debited

Returns string
The address/ID of the debited account
Implementation of ICredit.getAccountDebited
- Defined in models/financial/credit/Credit.ts:102

getFromProcess

getFromProcess(): string
Gets the process ID that originated this credit

Returns string
The process ID
Implementation of ICredit.getFromProcess
- Defined in models/financial/credit/Credit.ts:118

getId

getId(): string
Gets the unique identifier for this credit

Returns string
The credit ID
Implementation of ICredit.getId
- Defined in models/financial/credit/Credit.ts:110

getTokenBalance

getTokenBalance(): TokenBalance
Gets the token balance associated with this credit

Returns TokenBalance
The TokenBalance representing the credited amount
Implementation of ICredit.getTokenBalance
- Defined in models/financial/credit/Credit.ts:78

getTransactionDate

getTransactionDate(): Date
Gets the transaction date when the credit occurred

Returns Date
The date of the credit transaction
Implementation of ICredit.getTransactionDate
- Defined in models/financial/credit/Credit.ts:86

toString

toString(): string
Returns a string representation of the credit

Returns string
A formatted string containing credit details
Implementation of ICredit.toString
- Defined in models/financial/credit/Credit.ts:126

`Static`fromCreditNotice

fromCreditNotice(creditNotice: CreditNotice, tokenConfig: TokenConfig): Credit
Creates a Credit from a credit notice and token configuration
Parameters
- creditNotice: CreditNotice
  The credit notice containing transaction information
- tokenConfig: TokenConfig
  The token configuration for the credit
Returns Credit
A new Credit instance
- Defined in models/financial/credit/Credit.ts:35