Class TypeOrmNftMetadataService

Service to get CIP-25 NFT metadata for a given asset

Hierarchy

TypeormService
- TypeOrmNftMetadataService

Implements

NftMetadataService

Constructors

constructor

new TypeOrmNftMetadataService(__namedParameters: TypeormProviderDependencies): TypeOrmNftMetadataService
Parameters
- __namedParameters: TypeormProviderDependencies
Returns TypeOrmNftMetadataService
Overrides TypeormService.constructor
- Defined in packages/cardano-services/src/Asset/TypeOrmNftMetadataService.ts:8

Properties

`Private` #connectionConfig$

#connectionConfig$: Observable<PgConnectionConfig>

`Private` #connectionTimeout

#connectionTimeout: Milliseconds

`Private` #entities

#entities: Function[]

`Private` #subscription

#subscription: undefined | Subscription

`Protected` dataSource$

dataSource$: BehaviorSubject<null | DataSource> = ...

logger

logger: Logger

name

name: string

state

state: RunnableModuleState

Methods

`Private` #reset

#reset(): void
Returns void
Inherited from TypeormService.#reset
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:47

`Private` #subscribeToDataSource

#subscribeToDataSource(): Promise<unknown>
Returns Promise<unknown>
Inherited from TypeormService.#subscribeToDataSource
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:30

getNftMetadata

getNftMetadata(assetInfo: AssetPolicyIdAndName): Promise<null | NftMetadata>
Get CIP-25 NFT metadata for a given asset

Returns
CIP-25 NFT metadata for NFTs, null for assets that are not NFTs
Parameters
- assetInfo: AssetPolicyIdAndName
Returns Promise<null | NftMetadata>
Implementation of NftMetadataService.getNftMetadata
- Defined in packages/cardano-services/src/Asset/TypeOrmNftMetadataService.ts:12

getNftMetadataWith

getNftMetadataWith(assetInfo: AssetPolicyIdAndName, queryRunner: QueryRunner): Promise<null | {
    description: undefined | string;
    files: undefined | NftMetadataFile[];
    image: Uri;
    mediaType: undefined | ImageMediaType;
    name: string;
    otherProperties: undefined | Map<string, Metadatum>;
    version: string;
}>
Parameters
- assetInfo: AssetPolicyIdAndName
- queryRunner: QueryRunner
Returns Promise<null | {
    description: undefined | string;
    files: undefined | NftMetadataFile[];
    image: Uri;
    mediaType: undefined | ImageMediaType;
    name: string;
    otherProperties: undefined | Map<string, Metadatum>;
    version: string;
}>
- Defined in packages/cardano-services/src/Asset/TypeOrmNftMetadataService.ts:16

initialize

initialize(): Promise<void>
Returns Promise<void>
Inherited from TypeormService.initialize
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:15

initializeAfter

initializeAfter(): void
Returns void
Inherited from TypeormService.initializeAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:19

initializeBefore

initializeBefore(): void
Returns void
Inherited from TypeormService.initializeBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:18

initializeImpl

initializeImpl(): Promise<void>
Returns Promise<void>
Inherited from TypeormService.initializeImpl
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:89

onError

onError(_: unknown): void
Parameters
- _: unknown
Returns void
Inherited from TypeormService.onError
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:53

shutdown

shutdown(): Promise<void>
Returns Promise<void>
Inherited from TypeormService.shutdown
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:17

shutdownAfter

shutdownAfter(): void
Returns void
Inherited from TypeormService.shutdownAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:23

shutdownBefore

shutdownBefore(): void
Returns void
Inherited from TypeormService.shutdownBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:22

shutdownImpl

shutdownImpl(): Promise<void>
Returns Promise<void>
Inherited from TypeormService.shutdownImpl
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:97

start

start(): Promise<void>
Returns Promise<void>
Inherited from TypeormService.start
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:16

startAfter

startAfter(): void
Returns void
Inherited from TypeormService.startAfter
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:21

startBefore

startBefore(): void
Returns void
Inherited from TypeormService.startBefore
- Defined in packages/util/dist/cjs/RunnableModule.d.ts:20

startImpl

startImpl(): Promise<void>
Returns Promise<void>
Inherited from TypeormService.startImpl
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:93

withDataSource

withDataSource<T>(callback: ((dataSource: DataSource) => Promise<T>)): Promise<T>
Type Parameters
- T
Parameters
- callback: ((dataSource: DataSource) => Promise<T>)
  - - (dataSource: DataSource): Promise<T>
    - Parameters
      
      dataSource: DataSource
      
      Returns Promise<T>
Returns Promise<T>
Inherited from TypeormService.withDataSource
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:58

withQueryRunner

withQueryRunner<T>(callback: ((queryRunner: QueryRunner) => Promise<T>)): Promise<T>
Type Parameters
- T
Parameters
- callback: ((queryRunner: QueryRunner) => Promise<T>)
  - - (queryRunner: QueryRunner): Promise<T>
    - Parameters
      
      queryRunner: QueryRunner
      
      Returns Promise<T>
Returns Promise<T>
Inherited from TypeormService.withQueryRunner
- Defined in packages/cardano-services/src/util/TypeormService/TypeormService.ts:71

Class TypeOrmNftMetadataService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

__namedParameters: TypeormProviderDependencies

Returns TypeOrmNftMetadataService

Properties

Private #connectionConfig$

Private #connectionTimeout

Private #entities

Private #subscription

Protected dataSource$

logger

name

state

Methods

Private #reset

Returns void

Private #subscribeToDataSource

Returns Promise<unknown>

getNftMetadata

Returns

Parameters

assetInfo: AssetPolicyIdAndName

Returns Promise<null | NftMetadata>

getNftMetadataWith

Parameters

assetInfo: AssetPolicyIdAndName

queryRunner: QueryRunner

Returns Promise<null | { description: undefined | string; files: undefined | NftMetadataFile[]; image: Uri; mediaType: undefined | ImageMediaType; name: string; otherProperties: undefined | Map<string, Metadatum>; version: string; }>

initialize

Returns Promise<void>

initializeAfter

Returns void

initializeBefore

Returns void

initializeImpl

Returns Promise<void>

onError

Parameters

_: unknown

Returns void

shutdown

Returns Promise<void>

shutdownAfter

Returns void

shutdownBefore

Returns void

shutdownImpl

Returns Promise<void>

start

Returns Promise<void>

startAfter

Returns void

startBefore

Returns void

startImpl

Returns Promise<void>

withDataSource

Type Parameters

T

Parameters

callback: ((dataSource: DataSource) => Promise<T>)

Parameters

dataSource: DataSource

Returns Promise<T>

Returns Promise<T>

withQueryRunner

Type Parameters

T

Parameters

callback: ((queryRunner: QueryRunner) => Promise<T>)

Parameters

queryRunner: QueryRunner

`Private` #connectionConfig$

`Private` #connectionTimeout

`Private` #entities

`Private` #subscription

`Protected` dataSource$

`Private` #reset

`Private` #subscribeToDataSource

Returns Promise<null | {
description: undefined | string;
files: undefined | NftMetadataFile[];
image: Uri;
mediaType: undefined | ImageMediaType;
name: string;
otherProperties: undefined | Map<string, Metadatum>;
version: string;
}>