update contract

Author: tmctl

src/client/index.ts

@@ -4,6 +4,7 @@ import WebSocket from 'isomorphic-ws'
 import {createPatch} from 'rfc6902'
 import {AddOperation, RemoveOperation, ReplaceOperation} from 'rfc6902/diff'
 import {createClient, Client as SubscriptionClient} from '../../graphql-ws/src'
+import type {ExecutionResult} from 'graphql'
 import {
   Network,
   Environment,
@@ -65,10 +66,10 @@ export default class HgraphClient implements Client {
     this.subscriptions = []
   }
 
-  async query(
+  async query<T>(
     flexibleRequestBody: FlexibleRequestBody,
     abortSignal?: AbortSignal
-  ) {
+  ): Promise<ExecutionResult<T>> {
     const body = formatRequestBody(flexibleRequestBody)
     const response = await fetch(this.endpoint, {
       method: 'POST',
@@ -80,7 +81,7 @@ export default class HgraphClient implements Client {
     if (!response.ok)
       throw new Error(`${response.status} - ${response.statusText}`)
 
-    return parse(await response.text())
+    return parse(await response.text()) as ExecutionResult<T>
   }
 
   removeSubscription(observable: ObservableSubscription) {

src/contract/README.md

@@ -1,58 +1,86 @@
 # HgraphContract
 
-HgraphContract is designed to facilitate interaction with smart contracts on the Hedera network.
+HgraphContract is designed to facilitate interaction with smart contracts on the
+Hedera network.
 
 ## Usage
 
 ### Importing the Library
 
-To use the `HgraphContract` class, you need to import it along with the required types from the library:
+To use the `HgraphContract` class, you need to import it along with the required
+types from the library:
 
 ```typescript
 import {
-    default as HgraphClient,
-    Network, 
-    Environment, 
-    HgraphContract, 
-    ContractQueryEventsParams,
-} from '@hgraph.io/sdk';
+  default as HgraphClient,
+  Network,
+  Environment,
+  HgraphContract,
+  ContractQueryEventsParams,
+} from '@hgraph.io/sdk'
 ```
 
 ### Creating a HgraphClient instance
+
 ```typescript
 const options = {
   network: Network.HederaTestnet,
   environment: Environment.Development,
-};
+}
 
-const hgClient = new HgraphClient(options);
+const hgClient = new HgraphClient(options)
 ```
 
 ### Creating a HgraphContract Instance
-To create a contract instance, you need to provide the hedera contractId, contract ABI, and a hgraph client instance. 
-The hgraph client instance is responsible for communicating with the Hgraph GraphQL platform.
+
+To create a contract instance, you need to provide the hedera contractId,
+contract ABI, and a hgraph client instance. The hgraph client instance is
+responsible for communicating with the Hgraph GraphQL platform.
 
 ```typescript
 const contractOptions: ContractOptions = {
   contractId: '0.0.1234',
-  abi: [/* ABI array */],
+  abi: [
+    /* ABI array */
+  ],
   client: hgClient,
-};
+}
 
-const hgraphContract = new HgraphContract(contractOptions);
+const hgraphContract = new HgraphContract(contractOptions)
 ```
 
 ### Querying Events
 
-You can query events from the contract using the `queryEvents` method. This method allows you to specify parameters such as limit, offset, and order.
+You can query events from the contract using the `queryEvents` method. This
+method allows you to specify parameters such as limit, offset, and order.
 
 ```typescript
 const queryParams: ContractQueryEventsParams = {
   limit: 10,
   offset: 0,
   order: 'desc',
-};
+}
+
+const events = await hgraphContract.queryEvents(queryParams)
+console.log(events)
+```
+
+To strongly type the returned logs you can directly use the schema definitions
+that ship with the SDK:
 
-const events = await hgraphContract.queryEvents(queryParams);
-console.log(events);
-```
+```typescript
+import {ContractEventLogs} from '@hgraph.io/sdk'
+import type {Contract_Log} from '@hgraph.io/sdk'
+
+const {data} = await hgClient.query<{
+  logs: Pick<Contract_Log, 'data' | 'topic0' | 'topic1' | 'topic2' | 'topic3'>[]
+}>({
+  query: ContractEventLogs,
+  variables: {contract_id: 1234, limit: 10, offset: 0, order: 'desc'},
+})
+
+data.logs.forEach((log) => {
+  // log has type Pick<Contract_Log, 'data' | 'topic0' | 'topic1' | 'topic2' | 'topic3'>
+  console.log(log)
+})
+```

src/contract/index.ts

@@ -6,6 +6,7 @@ import HgraphClient, {
   ContractOptions,
   ContractQueryEventsParams,
 } from '../types'
+import type {Contract_Log} from '../types'
 
 export {LogDescription, InterfaceAbi, Contract as EthersContract} from 'ethers'
 
@@ -30,13 +31,10 @@ export class HgraphContract implements Contract {
     const {limit = 10, offset = 0, order = 'desc'} = params
 
     const {data: eventLogs, errors} = await this.client.query<{
-      logs: {
-        data: string | null
-        topic0: string | null
-        topic1: string | null
-        topic2: string | null
-        topic3: string | null
-      }[]
+      logs: Pick<
+        Contract_Log,
+        'data' | 'topic0' | 'topic1' | 'topic2' | 'topic3'
+      >[]
     }>({
       query: ContractEventLogs,
       variables: {