feat(graph): update schema to represent correct structure in preparat…

…ion of transition to kadindexer.io/graphql
kadena-community · Jan 10, 2025 · 1afb5ba · 1afb5ba
1 parent 5517c5d
commit 1afb5ba
Show file tree

Hide file tree

Showing 45 changed files with 285 additions and 201 deletions.
diff --git a/.changeset/green-scissors-refuse.md b/.changeset/green-scissors-refuse.md
@@ -0,0 +1,74 @@
+---
+'@kadena/graph': major
+---
+
+BREAKING CHANGES: we've introduced a number of breaking changes to prepare to
+transition to kadindexer.io/graphql
+
+Changes and their resolution
+
+## Breaking Changes
+
+### Without alternative
+
+- ✖ Field `Block.target` changed type from `Decimal!` to `String!`
+- ✖ Field `Block.weight` changed type from `Decimal!` to `String!`
+- ✖ Field `incrementedId` was removed from object type `Event`
+- ✖ Field `parameterText` was removed from object type `Event`
+- ✖ Type `MinerKey` was removed
+- ✖ Type `PositiveFloat` was removed
+- ✖ Field `metadata` was removed from object type `TransactionResult`
+
+### With Alternatives
+
+- ✖ Field `Query.fungibleChainAccount` changed type from `FungibleChainAccount`
+  to [FungibleChainAccount!]
+- ✖ Argument `chainId`: String! was removed from field
+  `Query.fungibleChainAccount`
+  - `chainId` was replaced by `chainIds: [String!]` with a default value
+- ✖ Field `blockHash` was removed from object type `Transfer`
+  - can be retrieved via `block.hash`
+- ✖ Field `chainId` was removed from object type `Transfer`
+  - can be retrieved via `block.chainId`
+- ✖ Field `height` was removed from object type `Transfer`
+  - can be retrieved via `block.height`
+
+## Improvements
+
+These shouldn't affect how it's being used. We changed the value for
+
+- `chainIds` to include all chains as the default value,
+- `fungibleName` to include `coin` as the default value
+
+and represented as such by GraphQL instead of a optional argument with a hidden
+default value.
+
+- ⚠ Default value
+  `[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ]` was
+  added to argument `chainIds` on field `Query.blocksFromDepth`
+- ⚠ Default value
+  `[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ]` was
+  added to argument `chainIds` on field `Query.blocksFromHeight`
+- ⚠ Default value
+  `[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ]` was
+  added to argument `chainIds` on field `Query.completedBlockHeights`
+- ⚠ Default value `coin` was added to argument fungibleName on field
+  `Query.fungibleAccount`
+- ⚠ Argument `chainIds: [String!]!` (with default value) added to field
+  `Query.fungibleChainAccount`
+- ⚠ Default value `coin` was added to argument fungibleName on field
+  `Query.fungibleChainAccount`
+- ⚠ Default value
+  `[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ]` was
+  added to argument `chainIds` on field `Subscription.newBlocks`
+- ⚠ Default value
+  `[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ]` was
+  added to argument `chainIds` on field `Subscription.newBlocksFromDepth`
+
+## Other Changes
+
+- ✔ Directive oneOf was added
+- ✔ Directive deprecated was added to field IGuard.keys
+- ✔ Directive deprecated was added to field IGuard.predicate
+- ✔ Type for argument chainIds on field Subscription.newBlocksFromDepth changed
+  from [String!]! to [String!]
diff --git a/.graphqlrc.ts b/.graphqlrc.ts
@@ -0,0 +1,21 @@
+// .graphqlrc.ts or graphql.config.ts
+export default {
+  projects: {
+    'graph-client': {
+      schema: ['./packages/apps/graph/generated-schema.graphql'],
+      documents: ['./packages/apps/graph-client/src/**/*.graph.ts'],
+    },
+    explorer: {
+      schema: ['./packages/apps/graph/generated-schema.graphql'],
+      documents: ['./packages/apps/explorer/src/**/*.graph.ts'],
+    },
+    'proof-of-us': {
+      schema: ['./packages/apps/graph/generated-schema.graphql'],
+      documents: ['./packages/apps/proof-of-us/src/**/*.graph.ts'],
+    },
+    'rwa-demo': {
+      schema: ['./packages/apps/graph/generated-schema.graphql'],
+      documents: ['./packages/apps/rwa-demo/src/**/*.graph.ts'],
+    },
+  },
+};
diff --git a/packages/apps/explorer/src/components/AccountTransfersTable/AccountTransfers.graph.ts b/packages/apps/explorer/src/components/AccountTransfersTable/AccountTransfers.graph.ts
@@ -20,13 +20,21 @@ export const accountTransfers: DocumentNode = gql`
           }
           edges {
             node {
-              requestKey
-              blockHash
+              transaction {
+                cmd {
+                  meta {
+                    chainId
+                  }
+                }
+                hash
+              }
+              block {
+                hash
+                height
+              }
               amount
-              chainId
               receiverAccount
               senderAccount
-              height
             }
           }
         }

diff --git a/packages/apps/explorer/src/components/LoadingSkeleton/loadingData/loadingDataBlockquery.ts b/packages/apps/explorer/src/components/LoadingSkeleton/loadingData/loadingDataBlockquery.ts
@@ -34,8 +34,8 @@ export const loadingData: BlockQuery = {
     },
     payloadHash: '',
     powHash: '',
-    target: 0,
-    weight: 0,
+    target: '',
+    weight: '',
     transactions: {
       totalCount: 0,
     },

diff --git a/...lorer/src/components/LoadingSkeleton/loadingData/loadingDataTransactionRequestKeyQuery.ts b/...lorer/src/components/LoadingSkeleton/loadingData/loadingDataTransactionRequestKeyQuery.ts
@@ -44,7 +44,6 @@ export const loadingTransactionData: TransactionRequestKeyQuery = {
       transactionId: 1,
       logs: '1',
       gas: 262,
-      metadata: null,
       continuation: null,
       __typename: 'TransactionResult',
       events: {

diff --git a/packages/apps/explorer/src/components/TransactionComponents/TransactionResultComponent.tsx b/packages/apps/explorer/src/components/TransactionComponents/TransactionResultComponent.tsx
@@ -93,8 +93,8 @@ export const TransactionResultComponent: React.FC<{
             },
             {
               key: 'Counterpart',
-              value: getCrosschainTransfer(transaction).requestKey,
-              link: `/transaction/${getCrosschainTransfer(transaction).requestKey}`,
+              value: getCrosschainTransfer(transaction).transaction?.hash || '',
+              link: `/transaction/${getCrosschainTransfer(transaction).transaction?.hash || ''}`,
             },
           ]}
         />
@@ -124,7 +124,6 @@ export const TransactionResultComponent: React.FC<{
               />
             ),
           },
-          { key: 'Metadata', value: transaction.metadata },
         ]}
       />
 

diff --git a/packages/apps/explorer/src/graphql/pages/transaction/transaction-requestkey.graph.ts b/packages/apps/explorer/src/graphql/pages/transaction/transaction-requestkey.graph.ts
@@ -57,7 +57,6 @@ export const transactionRequestKey: DocumentNode = gql`
             hash
             creationTime
           }
-          metadata
           continuation
           events {
             edges {
@@ -71,7 +70,9 @@ export const transactionRequestKey: DocumentNode = gql`
             edges {
               node {
                 crossChainTransfer {
-                  requestKey
+                  transaction {
+                    hash
+                  }
                   senderAccount
                   receiverAccount
                 }

diff --git a/packages/apps/explorer/src/services/format.ts b/packages/apps/explorer/src/services/format.ts
@@ -19,7 +19,16 @@ export function formatNumberWithUnit(number: number): string {
 }
 
 export function formatStatisticsData(
-  networkInfo: NetworkInfo | null | undefined,
+  networkInfo:
+    | Pick<
+        NetworkInfo,
+        | 'networkHashRate'
+        | 'totalDifficulty'
+        | 'transactionCount'
+        | 'coinsInCirculation'
+      >
+    | null
+    | undefined,
 ): { label: string; value: string }[] {
   if (!networkInfo) {
     return [

diff --git a/packages/apps/graph-client/apollo.config.js b/packages/apps/graph-client/apollo.config.js
@@ -2,7 +2,7 @@ module.exports = {
   client: {
     service: {
       name: 'graph',
-      localSchemaFile: __dirname + '/../graph/generated-schema.graphql',
+      localSchemaFile: `${__dirname}/../graph/generated-schema.graphql`,
     },
     includes: ['src/**/*.ts', 'src/**/*.tsx'],
     excludes: ['**/node_modulues/**/*', 'src/__generated__/**/*'],

diff --git a/packages/apps/graph-client/src/components/events-table/events-table.tsx b/packages/apps/graph-client/src/components/events-table/events-table.tsx
@@ -42,7 +42,7 @@ export const EventsTable = (props: IEventsTableProps): JSX.Element => {
                     <Column>Values</Column>
                   </TableHeader>
                   <TableBody>
-                    {JSON.parse(event.parameterText).map(
+                    {JSON.parse(event.parameters || '""').map(
                       (parameter: any, index: number) => (
                         <Row key={`arguments-${index}`}>
                           <Cell>

diff --git a/packages/apps/graph-client/src/graphql/fields/event.graph.ts b/packages/apps/graph-client/src/graphql/fields/event.graph.ts
@@ -3,7 +3,7 @@ import { gql } from '@apollo/client';
 
 export const CORE_EVENT_FIELDS: DocumentNode = gql`
   fragment CoreEventFields on Event {
-    parameterText
+    parameters
     qualifiedName
   }
 `;

diff --git a/packages/apps/graph-client/src/graphql/fields/miner-key.graph.ts b/packages/apps/graph-client/src/graphql/fields/miner-key.graph.ts
diff --git a/packages/apps/graph-client/src/graphql/fields/transaction.graph.ts b/packages/apps/graph-client/src/graphql/fields/transaction.graph.ts
@@ -75,7 +75,6 @@ export const ALL_TRANSACTION_FIELDS: DocumentNode = gql`
         gas
         goodResult
         logs
-        metadata
         eventCount
         transactionId
       }

diff --git a/packages/apps/graph-client/src/graphql/queries.graph.ts b/packages/apps/graph-client/src/graphql/queries.graph.ts
@@ -5,7 +5,6 @@ import {
   ALL_FUNGIBLE_CHAIN_ACCOUNT_FIELDS,
   CORE_FUNGIBLE_CHAIN_ACCOUNT_FIELDS,
 } from './fields/fungible-chain-account.graph';
-import { CORE_MINER_KEY_FIELDS } from './fields/miner-key.graph';
 import { ALL_NON_FUNGIBLE_ACCOUNT_FIELDS } from './fields/non-fungible-account.graph';
 import { CORE_NON_FUNGIBLE_CHAIN_ACCOUNT_FIELDS } from './fields/non-fungible-chain-account.graph';
 import { CORE_TRANSACTION_FIELDS } from './fields/transaction.graph';
@@ -17,7 +16,6 @@ import { gql } from '@apollo/client';
 export const getBlockFromHash: DocumentNode = gql`
   ${ALL_BLOCK_FIELDS}
   ${CORE_TRANSACTION_FIELDS}
-  ${CORE_MINER_KEY_FIELDS}
 
   query getBlockFromHash(
     $hash: String!
@@ -136,7 +134,7 @@ export const getFungibleChainAccount: DocumentNode = gql`
     fungibleChainAccount(
       fungibleName: $fungibleName
       accountName: $accountName
-      chainId: $chainId
+      chainIds: [$chainId]
     ) {
       ...AllFungibleChainAccountFields
       transactions {

diff --git a/packages/apps/graph-client/src/pages/account/overview/[fungible]/[account]/[chain].tsx b/packages/apps/graph-client/src/pages/account/overview/[fungible]/[account]/[chain].tsx
@@ -199,7 +199,7 @@ const ChainAccount: React.FC = () => {
                     </Cell>
                     <Cell>
                       {
-                        fungibleChainAccountData.fungibleChainAccount
+                        fungibleChainAccountData.fungibleChainAccount[0]
                           .fungibleName
                       }
                     </Cell>
@@ -209,7 +209,7 @@ const ChainAccount: React.FC = () => {
                       <strong>Balance</strong>
                     </Cell>
                     <Cell>
-                      {fungibleChainAccountData.fungibleChainAccount.balance}
+                      {fungibleChainAccountData.fungibleChainAccount[0].balance}
                     </Cell>
                   </Row>
                   <Row>
@@ -218,7 +218,7 @@ const ChainAccount: React.FC = () => {
                     </Cell>
                     <Cell>
                       {
-                        fungibleChainAccountData.fungibleChainAccount.guard
+                        fungibleChainAccountData.fungibleChainAccount[0].guard
                           .predicate
                       }
                     </Cell>
@@ -228,7 +228,10 @@ const ChainAccount: React.FC = () => {
                       <strong>Guard Keys</strong>
                     </Cell>
                     <Cell>
-                      {fungibleChainAccountData.fungibleChainAccount.guard.keys}
+                      {
+                        fungibleChainAccountData.fungibleChainAccount[0].guard
+                          .keys
+                      }
                     </Cell>
                   </Row>
                 </TableBody>
@@ -244,7 +247,7 @@ const ChainAccount: React.FC = () => {
                     chainId={router.query.chain as string}
                     truncateColumns={true}
                     transfers={
-                      fungibleChainAccountData.fungibleChainAccount
+                      fungibleChainAccountData.fungibleChainAccount[0]
                         .transfers as FungibleChainAccountTransfersConnection
                     }
                   />
@@ -258,7 +261,7 @@ const ChainAccount: React.FC = () => {
                     }`}
                     truncateColumns={true}
                     transactions={
-                      fungibleChainAccountData.fungibleChainAccount
+                      fungibleChainAccountData.fungibleChainAccount[0]
                         .transactions as FungibleChainAccountTransactionsConnection
                     }
                   />

diff --git a/packages/apps/graph-client/src/pages/transactions/[key].tsx b/packages/apps/graph-client/src/pages/transactions/[key].tsx
@@ -219,12 +219,6 @@ const RequestKey: React.FC = () => {
                           </Cell>
                           <Cell>{transaction.result.logs}</Cell>
                         </Row>
-                        <Row>
-                          <Cell>
-                            <strong>Metadata</strong>
-                          </Cell>
-                          <Cell>{transaction.result.metadata}</Cell>
-                        </Row>
                         <Row>
                           <Cell>
                             <strong>Continuation</strong>
@@ -282,7 +276,7 @@ const RequestKey: React.FC = () => {
                             <Cell>
                               <pre>
                                 {event?.node ? (
-                                  formatCode(event.node.parameterText)
+                                  formatCode(event.node.parameters || '""')
                                 ) : (
                                   <span style={{ color: 'lightgray' }}>
                                     N/A

diff --git a/packages/apps/graph/.graphqlrc.yml b/packages/apps/graph/.graphqlrc.yml