Non Fungible Token policies and guards (Feat)

.changeset/big-pots-attack.md

@@ -0,0 +1,6 @@
+---
+'@kadena/graph': patch
+---
+
+Add policies to non fungible token; restructure the guards and create JsonString
+object

.changeset/three-rules-mate.md

@@ -0,0 +1,5 @@
+---
+'@kadena/graph-client': patch
+---
+
+Adjusted client to changes made in graph schema for Guards and Policies

packages/apps/graph-client/src/components/chain-fungible-account-table/chain-fungible-account-table.tsx

@@ -51,8 +51,20 @@ export const FungibleChainAccountTable = (
                   {chainAccount.balance}
                 </Link>
               </Cell>
-              <Cell>{chainAccount.guard.predicate}</Cell>
-              <Cell>{chainAccount.guard.keys.join(', ')}</Cell>
+              <Cell>
+                {chainAccount.guard.__typename === 'Keyset' ? (
+                  chainAccount.guard.predicate
+                ) : (
+                  <span style={{ color: 'lightgray' }}>N/A</span>
+                )}
+              </Cell>
+              <Cell>
+                {chainAccount.guard.__typename === 'Keyset' ? (
+                  chainAccount.guard.keys.join(', ')
+                ) : (
+                  <span style={{ color: 'lightgray' }}>N/A</span>
+                )}
+              </Cell>
             </Row>
           ))}
         </TableBody>

packages/apps/graph-client/src/components/token-table/token-table.tsx

@@ -44,10 +44,21 @@ export const TokenTable = (props: ITokenTableProps): JSX.Element => {
                 <Cell>{token.tokenId}</Cell>
                 <Cell>{token.chainId}</Cell>
                 <Cell>{token.balance}</Cell>
+
                 <Cell>
-                  <strong>Predicate:</strong> {token.guard.predicate}
-                  <br />
-                  <strong>Keys:</strong> {token.guard.keys.join(', ')}
+                  {token.guard.__typename === 'Keyset' ? (
+                    <>
+                      <strong>Predicate:</strong> {token.guard.predicate}
+                      <br />
+                      <strong>Keys:</strong> {token.guard.keys.join(', ')}
+                    </>
+                  ) : token.guard.__typename === 'JsonString' ? (
+                    <>
+                      <strong>Guard:</strong> {token.guard.value}
+                    </>
+                  ) : (
+                    <span style={{ color: 'lightgray' }}>N/A</span>
+                  )}
                 </Cell>
               </Row>
             );

packages/apps/graph-client/src/graphql/fields/fungible-chain-account.graph.ts

@@ -15,8 +15,10 @@ export const ALL_FUNGIBLE_CHAIN_ACCOUNT_FIELDS: DocumentNode = gql`
     ...CoreFungibleChainAccountFields
     accountName
     guard {
-      keys
-      predicate
+      ... on Keyset {
+        keys
+        predicate
+      }
     }
     fungibleName
 

packages/apps/graph-client/src/graphql/queries.graph.ts

@@ -44,8 +44,10 @@ export const getBlockFromHash: DocumentNode = gql`
       }
       minerAccount {
         guard {
-          predicate
-          keys
+          ... on Keyset {
+            predicate
+            keys
+          }
         }
       }
       parent {
@@ -88,8 +90,10 @@ export const getFungibleAccount: DocumentNode = gql`
       chainAccounts {
         ...CoreFungibleChainAccountFields
         guard {
-          keys
-          predicate
+          ... on Keyset {
+            keys
+            predicate
+          }
         }
       }
       transactions {
@@ -337,8 +341,10 @@ export const getNonFungibleAccount: DocumentNode = gql`
         tokenId
         chainId
         guard {
-          predicate
-          keys
+          ... on Keyset {
+            predicate
+            keys
+          }
         }
       }
       transactions {
@@ -364,8 +370,10 @@ export const getNonFungibleChainAccount: DocumentNode = gql`
         tokenId
         chainId
         guard {
-          predicate
-          keys
+          ... on Keyset {
+            predicate
+            keys
+          }
         }
       }
       transactions {

packages/apps/graph-client/src/pages/account/overview/[fungible]/[account]/[chain].tsx

@@ -217,18 +217,29 @@ const ChainAccount: React.FC = () => {
                       <strong>Guard Predicate</strong>
                     </Cell>
                     <Cell>
-                      {
+                      {fungibleChainAccountData.fungibleChainAccount.guard
+                        .__typename === 'Keyset' ? (
                         fungibleChainAccountData.fungibleChainAccount.guard
                           .predicate
-                      }
+                      ) : (
+                        <span style={{ color: 'lightgray' }}>N/A</span>
+                      )}
                     </Cell>
                   </Row>
                   <Row>
                     <Cell>
                       <strong>Guard Keys</strong>
                     </Cell>
                     <Cell>
-                      {fungibleChainAccountData.fungibleChainAccount.guard.keys}
+                      <Cell>
+                        {fungibleChainAccountData.fungibleChainAccount.guard
+                          .__typename === 'Keyset' ? (
+                          fungibleChainAccountData.fungibleChainAccount.guard
+                            .keys
+                        ) : (
+                          <span style={{ color: 'lightgray' }}>N/A</span>
+                        )}
+                      </Cell>
                     </Cell>
                   </Row>
                 </TableBody>

packages/apps/graph-client/src/pages/block/overview/[hash].tsx

@@ -202,12 +202,17 @@ const Block: React.FC = () => {
                             <Column>Value</Column>
                           </TableHeader>
                           <TableBody>
-                            {data.block.minerAccount.guard.keys?.map(
-                              (minerKey, index) => (
-                                <Row key={index}>
-                                  <Cell>{minerKey}</Cell>
-                                </Row>
-                              ),
+                            {data.block.minerAccount.guard.__typename ===
+                            'Keyset' ? (
+                              data.block.minerAccount.guard.keys?.map(
+                                (minerKey, index) => (
+                                  <Row key={index}>
+                                    <Cell>{minerKey}</Cell>
+                                  </Row>
+                                ),
+                              )
+                            ) : (
+                              <span style={{ color: 'lightgray' }}>N/A</span>
                             )}
                           </TableBody>
                         </Table>
@@ -217,7 +222,14 @@ const Block: React.FC = () => {
                       <Cell>
                         <strong>Predicate</strong>
                       </Cell>
-                      <Cell>{data.block.minerAccount.guard.predicate}</Cell>
+                      <Cell>
+                        {data.block.minerAccount.guard.__typename ===
+                        'Keyset' ? (
+                          data.block.minerAccount.guard.predicate
+                        ) : (
+                          <span style={{ color: 'lightgray' }}>N/A</span>
+                        )}
+                      </Cell>
                     </Row>
                   </TableBody>
                 </Table>

packages/apps/graph/generated-schema.graphql

@@ -212,8 +212,17 @@ type GraphConfiguration {
   minimumBlockHeight: BigInt
 }
 
+"""A guard"""
+union Guard = JsonString | Keyset
+
+"""A JSON string."""
+type JsonString {
+  type: String!
+  value: String!
+}
+
 """Guard for an account."""
-type Guard {
+type Keyset {
   keys: [String!]!
   predicate: String!
 }
@@ -226,6 +235,12 @@ type MinerKey implements Node {
   key: String!
 }
 
+"""A reference to a module."""
+type ModuleReference {
+  name: String!
+  namespace: String!
+}
+
 """Information about the network."""
 type NetworkInfo {
   """The version of the API."""
@@ -302,25 +317,26 @@ type NonFungibleChainAccountTransactionsConnectionEdge {
   node: Transaction!
 }
 
-"""Information related to a token."""
-type NonFungibleToken {
-  precision: Int!
-  supply: Int!
-  uri: String!
-}
-
 """The token identifier and its balance."""
 type NonFungibleTokenBalance implements Node {
   accountName: String!
   balance: Int!
   chainId: String!
   guard: Guard!
   id: ID!
-  info: NonFungibleToken
+  info: NonFungibleTokenInfo
   tokenId: String!
   version: String!
 }
 
+"""Information related to a token."""
+type NonFungibleTokenInfo {
+  policies: [Policy!]!
+  precision: Int!
+  supply: Int!
+  uri: String!
+}
+
 input PactQuery {
   chainId: String!
   code: String!
@@ -348,6 +364,12 @@ type PageInfo {
   startCursor: String
 }
 
+"""A policy that defines the rules for a non-fungible token."""
+type Policy {
+  refName: ModuleReference!
+  refSpec: [ModuleReference!]!
+}
+
 """Floats that will have a value greater than 0."""
 scalar PositiveFloat
 

packages/apps/graph/src/devnet/deployment/marmalade/deploy.ts

@@ -37,11 +37,15 @@ export async function deployMarmaladeContracts(
   nsDestinationPath: string = marmaladeLocalConfig.namespacePath,
 ): Promise<void> {
   logger.info('Validating repository data...');
-  validateConfig(
-    marmaladeRepository,
-    marmaladeLocalConfig,
-    marmaladeRemoteConfig,
-  );
+  if (
+    !validateConfig(
+      marmaladeRepository,
+      marmaladeLocalConfig,
+      marmaladeRemoteConfig,
+    )
+  ) {
+    throw new Error('Invalid repository data');
+  }
 
   logger.info('Preparing directories...');
   await handleDirectorySetup(
@@ -362,8 +366,10 @@ export function validateConfig(
   repositoryConfig: IMarmaladeRepository,
   localConfig: IMarmaladeLocalConfig,
   remoteConfig: IMarmaladeRemoteConfig,
-): void {
-  validateObjectProperties(repositoryConfig, 'Repository');
-  validateObjectProperties(localConfig, 'Local');
-  validateObjectProperties(remoteConfig, 'Remote');
+): boolean {
+  return (
+    validateObjectProperties(repositoryConfig, 'Repository') &&
+    validateObjectProperties(localConfig, 'Local') &&
+    validateObjectProperties(remoteConfig, 'Remote')
+  );
 }

packages/apps/graph/src/devnet/simulation/marmalade/get-token-info.ts

@@ -9,6 +9,7 @@ interface ITokenInfo {
   precision: number;
   uri: string;
   id: string;
+  policies: { moduleName: string }[];
 }
 
 export const getTokenInfo = async (
@@ -97,5 +98,15 @@ export const getTokenInfo = async (
     }
   }
 
+  if ('policies' in tokenInfo) {
+    if (!Array.isArray(tokenInfo.policies)) {
+      tokenInfo.policies = tokenInfo.policies.map((policy: string) => ({
+        moduleName: policy,
+      }));
+    }
+  } else if ('policy' in tokenInfo) {
+    tokenInfo.policies = { moduleName: tokenInfo.policy.toString() };
+  }
+
   return tokenInfo as ITokenInfo;
 };

packages/apps/graph/src/graph/builder.ts

@@ -25,13 +25,16 @@ import type {
   IFungibleChainAccount,
   IGasLimitEstimation,
   IGraphConfiguration,
-  IGuard,
+  IJsonString,
+  IKeyset,
+  IModuleReference,
   INetworkInfo,
   INonFungibleAccount,
   INonFungibleChainAccount,
-  INonFungibleToken,
   INonFungibleTokenBalance,
+  INonFungibleTokenInfo,
   IPactQueryResponse,
+  IPolicy,
   ITransactionCapability,
   ITransactionCommand,
   ITransactionMempoolInfo,
@@ -80,11 +83,11 @@ export const builder = new SchemaBuilder<
       FungibleChainAccount: IFungibleChainAccount;
       GasLimitEstimation: IGasLimitEstimation;
       GraphConfiguration: IGraphConfiguration;
-      Guard: IGuard;
+      Keyset: IKeyset;
       NonFungibleAccount: INonFungibleAccount;
       NonFungibleChainAccount: INonFungibleChainAccount;
       NonFungibleTokenBalance: INonFungibleTokenBalance;
-      NonFungibleToken: INonFungibleToken;
+      NonFungibleTokenInfo: INonFungibleTokenInfo;
       TransactionMeta: ITransactionMeta;
       ExecutionPayload: IExecutionPayload;
       ContinuationPayload: IContinuationPayload;
@@ -94,6 +97,9 @@ export const builder = new SchemaBuilder<
       TransactionCapability: ITransactionCapability;
       TransactionSignature: ITransactionSignature;
       PactQueryResponse: IPactQueryResponse;
+      Policy: IPolicy;
+      ModuleReference: IModuleReference;
+      JsonString: IJsonString;
       NetworkInfo: INetworkInfo;
     };
   }

packages/apps/graph/src/graph/data-loaders/fungible-account-details.ts

@@ -1,5 +1,5 @@
 import type { IFungibleChainAccountDetails } from '@services/chainweb-node/fungible-account-details';
-import { getFungibleAccountDetails } from '@services/chainweb-node/fungible-account-details';
+import { getFungibleAccountDetailsWithRetry } from '@services/chainweb-node/fungible-account-details';
 import DataLoader from 'dataloader';
 
 interface IFungibleAccountDetailsKey {
@@ -14,7 +14,7 @@ export const fungibleAccountDetailsLoader = new DataLoader<
 >(async (keys: readonly IFungibleAccountDetailsKey[]) => {
   const results = await Promise.all(
     keys.map(({ fungibleName, accountName, chainId }) =>
-      getFungibleAccountDetails(fungibleName, accountName, chainId),
+      getFungibleAccountDetailsWithRetry(fungibleName, accountName, chainId),
     ),
   );