@radixdlt/atom/src/particles/meta/tokenParticle.ts

Container for CRUD instructions known as 'Particles' that are sent to the Radix decentralized ledger

import { SerializableKeyValues } from '@radixdlt/data-formats'
import {
	AmountT,
	Granularity,
	granularityDefault,
	Nonce,
	randomNonce,
} from '@radixdlt/primitives'
import { pipe } from '@radixdlt/util'
import {
	makeTokenPermissions,
	tokenPermissionsAll,
} from '../../tokenPermissions'
import {
	ResourceIdentifierT,
	TokenPermission,
	TokenPermissions,
	TokenTransition,
} from '../../_types'
import { TokenParticle } from '../_types'
import { withParticleEquals } from './particle'

export type TokenParticleInput = Readonly<{
	amount: AmountT
	resourceIdentifier: ResourceIdentifierT
	granularity?: Granularity
	permissions?: Readonly<{ [key in TokenTransition]: TokenPermission }>
	nonce?: Nonce
}>

const withNonce = (
	input: TokenParticleInput,
): TokenParticleInput & { nonce: Nonce } => ({
	...input,
	nonce: input.nonce ?? randomNonce(),
})

const withAmount = (
	input: TokenParticleInput,
): TokenParticleInput & { amount: AmountT } => ({
	...input,
	amount: input.amount,
})

const withPermissions = (
	input: TokenParticleInput,
): Omit<TokenParticleInput, 'permissions'> & {
	permissions: TokenPermissions
} => ({
	...input,
	permissions: input.permissions
		? makeTokenPermissions(input.permissions)
		: tokenPermissionsAll,
})

const withGranularity = (
	input: TokenParticleInput,
): TokenParticleInput & { granularity: Granularity } => ({
	...input,
	granularity: input.granularity ?? granularityDefault,
})

export const tokenSerializationKeyValues = (
	input: TokenParticle,
): SerializableKeyValues => ({
	tokenDefinitionReference: input.resourceIdentifier,
	granularity: input.granularity,
	permissions: input.permissions,
	nonce: input.nonce,
	amount: input.amount,
})

export const withTokenParticleEquals = withParticleEquals.bind(
	null,
	(p1: TokenParticle, p2: TokenParticle) =>
		p1.resourceIdentifier.equals(p2.resourceIdentifier) &&
		p1.amount.equals(p2.amount) &&
		p1.granularity.equals(p2.granularity) &&
		p1.permissions.equals(p2.permissions),
)

export const tokenParticleProps = (input: TokenParticleInput): TokenParticle =>
	// eslint-disable-next-line  @typescript-eslint/no-unsafe-return
	pipe(withNonce, withAmount, withPermissions, withGranularity)(input)