feat: add fractional token option for mint

Akord-com · Apr 10, 2024 · 2da70c2 · 2da70c2
1 parent f0ee0cc
commit 2da70c2
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 1 deletion.
diff --git a/src/__tests__/nft.test.ts b/src/__tests__/nft.test.ts
@@ -3,6 +3,7 @@ import faker from '@faker-js/faker';
 import { initInstance, testDataPath } from './common';
 import { email, password } from './data/test-credentials';
 import { NodeJs } from "../types/file";
+import { DEFAULT_FRACTION_PARTS } from "../core/nft";
 
 let akord: Akord;
 
@@ -52,6 +53,7 @@ describe("Testing NFT functions", () => {
     expect(nft.creator).toEqual(nftMetadata.creator);
     expect(nft.collection).toEqual(nftMetadata.collection);
     expect(nft.description).toEqual(nftMetadata.description);
+    expect(nft.balances[nft.owner]).toEqual(1);
     expect(nft.asset.udl?.license).toEqual(UDL_LICENSE_TX_ID);
     expect(nft.asset.udl?.licenseFee?.type).toEqual(udl.licenseFee?.type);
     expect(nft.asset.udl?.licenseFee?.value).toEqual(udl.licenseFee?.value);
@@ -78,6 +80,7 @@ describe("Testing NFT functions", () => {
       description: "Discover the enchanting world of Flora Fantasy, where nature meets fantasy in mesmerizing digital artworks",
       topics: ["floral", "nature"],
       types: ["image", "collection"],
+      fractional: true,
       banner: file,
     } as CollectionMetadata;
 
@@ -111,6 +114,7 @@ describe("Testing NFT functions", () => {
     expect(nft.owner).toEqual(collectionMetadata.owner);
     expect(nft.creator).toEqual(collectionMetadata.creator);
     expect(nft.description).toEqual(collectionMetadata.description);
+    expect(nft.balances[nft.owner]).toEqual(DEFAULT_FRACTION_PARTS);
     expect(nft.asset.udl?.license).toEqual(UDL_LICENSE_TX_ID);
     expect(nft.asset.udl?.licenseFee?.type).toEqual(udl.licenseFee?.type);
     expect(nft.asset.udl?.licenseFee?.value).toEqual(udl.licenseFee?.value);

diff --git a/src/core/nft.ts b/src/core/nft.ts
@@ -11,6 +11,7 @@ import { StackService } from "./stack";
 import { isArweaveId } from "../arweave";
 
 const DEFAULT_TICKER = "ATOMIC";
+export const DEFAULT_FRACTION_PARTS = 100;
 
 class NFTService extends NodeService<NFT> {
   objectType = nodeType.NFT;
@@ -147,7 +148,7 @@ export const nftMetadataToTags = (metadata: NFTMetadata): Tags => {
     owner: metadata.owner,
     canEvolve: true,
     balances: {
-      [metadata.owner]: 1,
+      [metadata.owner]: metadata.fractional ? (metadata.fractionParts || DEFAULT_FRACTION_PARTS) : 1,
     },
     claimable: []
   } as any;

diff --git a/src/types/collection.ts b/src/types/collection.ts
@@ -46,6 +46,8 @@ export type CollectionMetadata = {
   contractTxId?: string, // default to "Of9pi--Gj7hCTawhgxOwbuWnFI1h24TTgO5pw8ENJNQ"
   banner?: FileSource,
   thumbnail?: FileSource,
+  fractional?: boolean, // allow multiple collectors to own fractions of the same Atomic NFT
+  fractionParts?: number // used when fractional option is set to true, default to 100
 } & AssetMetadata
 
 export type CollectionMintOptions = NFTMintOptions & Hooks
diff --git a/src/types/nft.ts b/src/types/nft.ts
@@ -52,6 +52,8 @@ export type NFTMetadata = {
   contractTxId?: string, // default to "Of9pi--Gj7hCTawhgxOwbuWnFI1h24TTgO5pw8ENJNQ"
   ticker?: string, // default to "ATOMIC"
   thumbnail?: FileSource,
+  fractional?: boolean, // allow multiple collectors to own fractions of the same Atomic NFT
+  fractionParts?: number // used when fractional option is set to true, default to 100
 } & AssetMetadata
 
 export type NFTMintOptions = {