feat: include NFT asset types

mechanismHQ · Mar 8, 2023 · 22a2ea7 · 22a2ea7
1 parent 183b227
commit 22a2ea7
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 14 deletions.
diff --git a/.changeset/tiny-meals-breathe.md b/.changeset/tiny-meals-breathe.md
@@ -0,0 +1,7 @@
+---
+"clarigen-deno": minor
+---
+
+Updates the `ClarityAbiNonFungibleToken` type to include a JS-native type.
+
+Fixed an issue when fetching variables in projects that use requirements.
diff --git a/artifacts/clarigen/index.ts b/artifacts/clarigen/index.ts
@@ -86,17 +86,18 @@ export interface ClarityAbiTypeFungibleToken {
   name: string;
 }
 
-export interface ClarityAbiTypeNonFungibleToken {
+export interface ClarityAbiTypeNonFungibleToken<T = unknown> {
   name: string;
   type: ClarityAbiType;
+  _t?: T;
 }
 
 export interface ClarityAbi {
   functions: ClarityAbiFunction[];
   variables: ClarityAbiVariable[];
   maps: ClarityAbiMap[];
   fungible_tokens: ClarityAbiTypeFungibleToken[];
-  non_fungible_tokens: ClarityAbiTypeNonFungibleToken[];
+  non_fungible_tokens: ClarityAbiTypeNonFungibleToken<unknown>[];
 }
 
 export type TypedAbi = Readonly<{
@@ -113,7 +114,7 @@ export type TypedAbi = Readonly<{
     [key: string]: unknown;
   };
   fungible_tokens: Readonly<ClarityAbiTypeFungibleToken[]>;
-  non_fungible_tokens: Readonly<ClarityAbiTypeNonFungibleToken[]>;
+  non_fungible_tokens: Readonly<ClarityAbiTypeNonFungibleToken<unknown>[]>;
   contractName: string;
   contractFile?: string;
 }>;
@@ -210,6 +211,7 @@ export const contracts = {
     },
     'non_fungible_tokens': [],
     'fungible_tokens': [],
+    'epoch': 'Epoch21',
     'clarity_version': 'Clarity2',
     contractName: 'counter',
   },
@@ -220,6 +222,7 @@ export const contracts = {
     constants: {},
     'non_fungible_tokens': [],
     'fungible_tokens': [],
+    'epoch': 'Epoch20',
     'clarity_version': 'Clarity1',
     contractName: 'ft-trait',
   },
@@ -375,9 +378,13 @@ export const contracts = {
             { 'name': 'namespace', 'type': { 'buffer': { 'length': 20 } } },
           ],
         },
-      } as ClarityAbiTypeNonFungibleToken,
+      } as ClarityAbiTypeNonFungibleToken<{
+        'name': Uint8Array;
+        'namespace': Uint8Array;
+      }>,
     ],
     'fungible_tokens': [],
+    'epoch': 'Epoch20',
     'clarity_version': 'Clarity1',
     contractName: 'tester',
   },

diff --git a/src/cli/files/base.ts b/src/cli/files/base.ts
@@ -40,7 +40,10 @@ export function generateContractMeta(
   const variableLines = encodeVariables(variables);
 
   const nftLines = non_fungible_tokens.map((nft) => {
-    return `${JSON.stringify(nft)} as ClarityAbiTypeNonFungibleToken`;
+    const keyType = jsTypeFromAbiType(nft.type);
+    return `${
+      JSON.stringify(nft)
+    } as ClarityAbiTypeNonFungibleToken<${keyType}>`;
   });
 
   return `{

diff --git a/src/cli/files/variables.ts b/src/cli/files/variables.ts
@@ -10,7 +10,17 @@ export function getVariables(contract: SessionContract, sessionId: number) {
   const deployer = 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM';
   const fakeId = `${getContractName(contract.contract_id)}-vars`;
 
-  if (contract.contract_interface.variables.length === 0) return '{}';
+  if (contract.contract_interface.variables.length === 0) {
+    const deploy = Tx.deployContract(
+      getContractName(contract.contract_id, false),
+      contract.source,
+      deployer,
+    );
+    (deploy.deployContract as any).clarityVersion = 2;
+    (deploy.deployContract as any).epoch = '2.1';
+    chain.mineBlock([deploy]);
+    return '{}';
+  }
 
   let varFn = `{\n`;
 

diff --git a/src/cli/type-stub.ts b/src/cli/type-stub.ts
@@ -87,17 +87,18 @@ export interface ClarityAbiTypeFungibleToken {
   name: string;
 }
 
-export interface ClarityAbiTypeNonFungibleToken {
+export interface ClarityAbiTypeNonFungibleToken<T = unknown> {
   name: string;
   type: ClarityAbiType;
+  _t?: T;
 }
 
 export interface ClarityAbi {
   functions: ClarityAbiFunction[];
   variables: ClarityAbiVariable[];
   maps: ClarityAbiMap[];
   fungible_tokens: ClarityAbiTypeFungibleToken[];
-  non_fungible_tokens: ClarityAbiTypeNonFungibleToken[];
+  non_fungible_tokens: ClarityAbiTypeNonFungibleToken<unknown>[];
 }
 
 export type TypedAbi = Readonly<{
@@ -114,7 +115,7 @@ export type TypedAbi = Readonly<{
     [key: string]: unknown;
   };
   fungible_tokens: Readonly<ClarityAbiTypeFungibleToken[]>;
-  non_fungible_tokens: Readonly<ClarityAbiTypeNonFungibleToken[]>;
+  non_fungible_tokens: Readonly<ClarityAbiTypeNonFungibleToken<unknown>[]>;
   contractName: string;
   contractFile?: string;
 }>;

diff --git a/src/types.ts b/src/types.ts
@@ -86,17 +86,18 @@ export interface ClarityAbiTypeFungibleToken {
   name: string;
 }
 
-export interface ClarityAbiTypeNonFungibleToken {
+export interface ClarityAbiTypeNonFungibleToken<T = unknown> {
   name: string;
   type: ClarityAbiType;
+  _t?: T;
 }
 
 export interface ClarityAbi {
   functions: ClarityAbiFunction[];
   variables: ClarityAbiVariable[];
   maps: ClarityAbiMap[];
   fungible_tokens: ClarityAbiTypeFungibleToken[];
-  non_fungible_tokens: ClarityAbiTypeNonFungibleToken[];
+  non_fungible_tokens: ClarityAbiTypeNonFungibleToken<unknown>[];
 }
 
 export type TypedAbi = Readonly<{
@@ -113,7 +114,7 @@ export type TypedAbi = Readonly<{
     [key: string]: unknown;
   };
   fungible_tokens: Readonly<ClarityAbiTypeFungibleToken[]>;
-  non_fungible_tokens: Readonly<ClarityAbiTypeNonFungibleToken[]>;
+  non_fungible_tokens: Readonly<ClarityAbiTypeNonFungibleToken<unknown>[]>;
   contractName: string;
   contractFile?: string;
 }>;

diff --git a/tests/counter_test.ts b/tests/counter_test.ts
@@ -49,6 +49,6 @@ describe('BDD-style testing', () => {
       txOk(counter.decrement(1n), alice),
     );
     assertEquals(receipt.value, 2n);
-    assertEquals(chain.blockHeight, 3);
+    assertEquals(chain.blockHeight, 4);
   });
 });
diff --git a/tests/helper.ts b/tests/helper.ts
@@ -2,7 +2,7 @@
 // This file is automatically generated by Clarigen.
 // Don't make changes to this file, or they'll
 // be overwritten.
-import { factory } from "https://deno.land/x/clarigen@v0.4.15/mod.ts";
+import { factory } from "https://deno.land/x/clarigen@v0.4.16/mod.ts";
 import { simnet } from "./../artifacts/clarigen/index.ts";
 
 export const { test, contracts, accounts } = factory(simnet);