Feat: Add feeFactory (#27)

* Feat: Add fixFactory

Signed-off-by: Stanislaw Mazowiecki <[email protected]>

---------

Signed-off-by: Stanislaw Mazowiecki <[email protected]>

src/FeeFactory.ts

@@ -0,0 +1,38 @@
+import { FixedFeeType, RoyaltyFeeType } from './types/fees';
+import { createFixedFeeFunction } from './functions/createFixedFeeFunction';
+import { CustomFixedFee, CustomRoyaltyFee } from '@hashgraph/sdk';
+import { createRoyaltyFeeFunction } from './functions/createRoyaltyFeeFunction';
+
+export class FeeFactory {
+  fixedFee({
+    collectorAccountId,
+    hbarAmount,
+    amount,
+    denominatingTokenId,
+    allCollectorsAreExempt,
+  }: FixedFeeType): CustomFixedFee {
+    return createFixedFeeFunction({
+      collectorAccountId,
+      hbarAmount,
+      amount,
+      denominatingTokenId,
+      allCollectorsAreExempt,
+    });
+  }
+
+  royaltyFee({
+    collectorAccountId,
+    numerator,
+    denominator,
+    fallbackFee,
+    allCollectorsAreExempt,
+  }: RoyaltyFeeType): CustomRoyaltyFee {
+    return createRoyaltyFeeFunction({
+      collectorAccountId,
+      numerator,
+      denominator,
+      fallbackFee,
+      allCollectorsAreExempt,
+    });
+  }
+}

src/HederaNFTSDK.ts

@@ -1,4 +1,4 @@
-import { Client, NftId, PrivateKey } from '@hashgraph/sdk';
+import { Client, CustomFee, NftId, PrivateKey } from '@hashgraph/sdk';
 import { NetworkName } from '@hashgraph/sdk/lib/client/Client';
 import { createCollectionFunction } from './functions/createCollection';
 import { createJsonMetadataFromCSV } from './functions/createJsonMetadataFromCSV';
@@ -29,13 +29,15 @@ export class HederaNFTSDK {
     treasuryAccount,
     keys,
     maxSupply,
+    customFees,
   }: {
     collectionName: string;
     collectionSymbol: string;
     treasuryAccountPrivateKey?: string;
     treasuryAccount?: string;
     keys?: CreateCollectionKeysType;
     maxSupply?: number;
+    customFees?: CustomFee[];
   }) {
     return createCollectionFunction({
       client: this.client,
@@ -46,6 +48,7 @@ export class HederaNFTSDK {
       treasuryAccount,
       treasuryAccountPrivateKey,
       maxSupply,
+      customFees,
     });
   }
 

src/functions/createCollection.ts

@@ -25,7 +25,8 @@ export const createCollectionFunction = async ({
     collectionName,
     collectionSymbol,
     treasuryAccount,
-    treasuryAccountPrivateKey
+    treasuryAccountPrivateKey,
+    customFees,
   });
 
   const treasuryAccountId = treasuryAccount

src/functions/createFixedFeeFunction.ts

@@ -0,0 +1,32 @@
+import { FixedFeeType } from '../types/fees';
+import { CustomFixedFee, Hbar } from '@hashgraph/sdk';
+import { validatePropsForFixedFeeFunction } from '../utils/validateProps';
+
+export const createFixedFeeFunction = ({
+  collectorAccountId,
+  hbarAmount,
+  amount,
+  denominatingTokenId,
+  allCollectorsAreExempt,
+}: FixedFeeType): CustomFixedFee => {
+  validatePropsForFixedFeeFunction({ collectorAccountId, hbarAmount, amount, denominatingTokenId });
+  const fixedFee = new CustomFixedFee().setFeeCollectorAccountId(collectorAccountId);
+
+  if (hbarAmount) {
+    fixedFee.setHbarAmount(Hbar.fromString(hbarAmount.toString()));
+  }
+
+  if (amount) {
+    fixedFee.setAmount(amount);
+  }
+
+  if (denominatingTokenId) {
+    fixedFee.setDenominatingTokenId(denominatingTokenId);
+  }
+
+  if (allCollectorsAreExempt) {
+    fixedFee.setAllCollectorsAreExempt(allCollectorsAreExempt);
+  }
+
+  return fixedFee;
+};

src/functions/createRoyaltyFeeFunction.ts

@@ -0,0 +1,37 @@
+import { CustomRoyaltyFee } from '@hashgraph/sdk';
+import { RoyaltyFeeType } from '../types/fees';
+import { createFixedFeeFunction } from './createFixedFeeFunction';
+import { validatePropsForRoyaltyFeeFunction } from '../utils/validateProps';
+
+export const createRoyaltyFeeFunction = ({
+  collectorAccountId,
+  numerator,
+  denominator,
+  fallbackFee,
+  allCollectorsAreExempt,
+}: RoyaltyFeeType) => {
+  validatePropsForRoyaltyFeeFunction({ collectorAccountId, numerator, denominator });
+
+  const royaltyFee = new CustomRoyaltyFee()
+    .setFeeCollectorAccountId(collectorAccountId)
+    .setNumerator(numerator)
+    .setDenominator(denominator);
+
+  if (allCollectorsAreExempt) {
+    royaltyFee.setAllCollectorsAreExempt(allCollectorsAreExempt);
+  }
+
+  if (fallbackFee) {
+    royaltyFee.setFallbackFee(
+      createFixedFeeFunction({
+        collectorAccountId: fallbackFee.collectorAccountId,
+        hbarAmount: fallbackFee.hbarAmount,
+        amount: fallbackFee.amount,
+        denominatingTokenId: fallbackFee.denominatingTokenId,
+        allCollectorsAreExempt: fallbackFee.allCollectorsAreExempt,
+      })
+    );
+  }
+
+  return royaltyFee;
+};

src/types/fees.ts

@@ -0,0 +1,15 @@
+export type FixedFeeType = {
+  collectorAccountId: string;
+  hbarAmount?: number;
+  amount?: number;
+  denominatingTokenId?: string;
+  allCollectorsAreExempt?: boolean;
+};
+
+export type RoyaltyFeeType = {
+  collectorAccountId: string;
+  numerator: number;
+  denominator: number;
+  fallbackFee?: FixedFeeType;
+  allCollectorsAreExempt?: boolean;
+};

src/types/validateProps.ts

@@ -1,4 +1,4 @@
-import { Client, NftId, PrivateKey } from '@hashgraph/sdk';
+import { Client, NftId, PrivateKey, CustomFee } from '@hashgraph/sdk';
 
 export type sharedMintingValidationProps = {
   batchSize?: number;
@@ -23,11 +23,24 @@ export type increaseNFTSupplyValidationProps = {
   supplyKey?: PrivateKey;
 };
 
-
 export type validateCreateCollectionProps = {
   client?: Client;
   collectionName?: string;
   collectionSymbol?: string;
   treasuryAccountPrivateKey?: string;
   treasuryAccount?: string;
+  customFees?: CustomFee[];
+};
+
+export type fixedFeeValidationProps = {
+  collectorAccountId?: string;
+  hbarAmount?: number;
+  amount?: number;
+  denominatingTokenId?: string;
+};
+
+export type royaltyFeeValidationProps = {
+  collectorAccountId?: string;
+  numerator: number;
+  denominator: number;
 };

src/utils/constants/dictionary.ts

@@ -14,6 +14,12 @@ export const dictionary = {
     treasuryAccountPrivateKeySignRequired:
       'If you want to use treasuryAccount to sign, you need to pass the treasuryAccountPrivateKey also',
     collectionNotCreated: 'Something went wrong while creating the collection',
+    tooManyCustomFees: 'You can only have 10 custom fees',
+    collectorAccountIdRequired: 'collectorAccountId is required',
+    numeratorRequired: 'numerator is required',
+    denominatorRequired: 'denominator is required',
+    hbarAmountOrAmountAndDenominatingToken:
+      'Either hbarAmount should be set and both amount and denominatingTokenId should not be set, or amount and denominatingTokenId should be set and hbarAmount should not be set.',
   },
   csvToJson: {
     errorInCellWithHeader: (line: number, column: number) =>

src/utils/validateProps.ts

@@ -3,6 +3,8 @@ import {
   validateCreateCollectionProps,
   uniqueMintingValidationProps,
   increaseNFTSupplyValidationProps,
+  fixedFeeValidationProps,
+  royaltyFeeValidationProps,
 } from '../types/validateProps';
 import { dictionary } from './constants/dictionary';
 
@@ -26,14 +28,61 @@ export const validatePropsForCreateCollection = (props: validateCreateCollection
   validateCollectionSymbol(props);
   validateCollectionName(props);
   validateClient(props);
+  validateCustomFees(props);
+};
+
+export const validatePropsForFixedFeeFunction = (props: fixedFeeValidationProps) => {
+  validateCollectorAccountId(props);
+  hbarAmountOrAmountAndDenominatingToken(props);
+};
+
+export const validatePropsForRoyaltyFeeFunction = (props: royaltyFeeValidationProps) => {
+  validateCollectorAccountId(props);
+  validateNumerator(props);
+  validateDenominator(props);
+};
+
+const hbarAmountOrAmountAndDenominatingToken = (props: fixedFeeValidationProps) => {
+  if (
+    (props.hbarAmount && (props.amount || props.denominatingTokenId)) ||
+    (!props.hbarAmount && (!props.amount || !props.denominatingTokenId))
+  ) {
+    throw new Error(dictionary.createCollection.hbarAmountOrAmountAndDenominatingToken);
+  }
+};
+
+const validateNumerator = (props: royaltyFeeValidationProps) => {
+  if (Object.prototype.hasOwnProperty.call(props, 'numerator')) {
+    if (!props.numerator) throw new Error(dictionary.createCollection.numeratorRequired);
+  }
+};
+
+const validateDenominator = (props: royaltyFeeValidationProps) => {
+  if (Object.prototype.hasOwnProperty.call(props, 'denominator')) {
+    if (!props.denominator) throw new Error(dictionary.createCollection.denominatorRequired);
+  }
+};
+
+const validateCollectorAccountId = (props: fixedFeeValidationProps) => {
+  if (Object.prototype.hasOwnProperty.call(props, 'collectorAccountId')) {
+    if (!props.collectorAccountId)
+      throw new Error(dictionary.createCollection.collectorAccountIdRequired);
+  }
+};
+
+const validateCustomFees = (props: validateCreateCollectionProps) => {
+  if (Object.prototype.hasOwnProperty.call(props, 'collectionSymbol')) {
+    if (props.customFees && props.customFees.length > 10)
+      throw new Error(dictionary.createCollection.tooManyCustomFees);
+  }
 };
 
 export const validatePropsForIncreaseNFTSupply = (props: increaseNFTSupplyValidationProps) => {
   validateSupplyKey(props);
   validateBatchSize(props);
   validateNFTId(props);
   validateAmount(props);
-}
+};
 
 const validateAccountAndPrivateKey = (props: validateCreateCollectionProps) => {
   if (

test/__mocks__/consts.ts

@@ -1,4 +1,5 @@
 export const myAccountId = '0.0.12345';
+export const mySecondAccountId = '0.0.123';
 export const myPrivateKey =
   '123e020100300506032b657004220420f8e9f8de8f7e06f7e9f8de8f7e06f7e9f8de8f7e06f7e9f8de8f7e06f7e9f8de';
 

test/e2e/e2eConsts.ts

@@ -1,5 +1,6 @@
 import { HederaNFTSDK } from '../../src/HederaNFTSDK';
 import 'dotenv/config';
+import { FeeFactory } from '../../src/FeeFactory';
 
 export const operatorAccountId = process.env.FIRST_ACCOUNT_ID!;
 export const operatorPrivateKey = process.env.FIRST_PRIVATE_KEY!;
@@ -8,3 +9,5 @@ export const secondAccountId = process.env.SECOND_ACCOUNT_ID!;
 export const secondPrivateKey = process.env.SECOND_PRIVATE_KEY!;
 
 export const nftSDK = new HederaNFTSDK(operatorAccountId, operatorPrivateKey, 'testnet');
+
+export const feeFactoryInstance = new FeeFactory();