coderabbitai[bot]
commented
1 month ago Walkthrough
The pull request introduces several changes across the kleros-sdk project, including updates to the .gitignore file, modifications in JSON configuration for dispute templates, and significant alterations in the package.json. Import paths have been standardized using a tilde prefix, enhancing module resolution. Various TypeScript types have been added or modified, particularly concerning data mappings and validation mechanisms. Additionally, new TypeScript files for GraphQL utilities have been created, and existing configuration files have been updated to reflect changes in compiler options and module systems.
Changes
| File Path | Change Summary |
|---|---|
kleros-sdk/.gitignore |
Updated to ignore lib, dist, and node_modules directories. |
kleros-sdk/config/v2-disputetemplate/reality/example3/DisputeTemplate.json.mustache |
Updated arbitratorChainID from "421613" to "421614". |
kleros-sdk/package.json |
Updated version to 2.0.1-3, changed main entry to ./lib/src/index.js, added types and module entries, restructured repository, added files and publishConfig fields, and modified scripts. |
kleros-sdk/src/dataMappings/actions/callAction.ts |
Updated import paths for AbiCallMapping, createResultObject, and SDK functions to use a tilde prefix. |
kleros-sdk/src/dataMappings/actions/eventAction.ts |
Updated import paths for AbiEventMapping, createResultObject, and SDK functions to use a tilde prefix. |
kleros-sdk/src/dataMappings/actions/fetchIpfsJsonAction.ts |
Updated import paths for FetchIpfsJsonMapping, createResultObject, and MAX_BYTE_SIZE to use a tilde prefix. |
kleros-sdk/src/dataMappings/actions/jsonAction.ts |
Updated import paths for JsonMapping and createResultObject to use a tilde prefix. |
kleros-sdk/src/dataMappings/actions/subgraphAction.ts |
Updated import paths for SubgraphMapping and createResultObject to use a tilde prefix. |
kleros-sdk/src/dataMappings/decoder.ts |
Updated import statements, simplified graphqlQueryFnHelper function signature, and modified genericDecoder logic to reflect changes in disputeTemplateRegistry. |
kleros-sdk/src/dataMappings/executeActions.ts |
Updated method signatures to use DataMapping and DisputeRequest types, added validation for "reality" action type. |
kleros-sdk/src/dataMappings/retrieveRealityData.ts |
Updated variable types from AbiEventMapping to DataMapping<AbiEventMapping>, and explicitly defined answers as an array of Answer objects. |
kleros-sdk/src/dataMappings/utils/actionTypes.ts |
Deleted file containing several TypeScript type definitions related to mapping structures. |
kleros-sdk/src/dataMappings/utils/dataMappingTypes.ts |
Introduced new types JsonMapping, AbiCallMapping, and RealityMapping, modified AbiEventMapping, and added DataMapping type. |
kleros-sdk/src/dataMappings/utils/dataMappingValidators.ts |
Updated validation functions to accept DataMapping type instead of ActionMapping. |
kleros-sdk/src/dataMappings/utils/disputeRequest.ts |
Introduced a new type definition DisputeRequest. |
kleros-sdk/src/dataMappings/utils/populateTemplate.ts |
Updated import path for the validate function and added a comment regarding validation logic. |
kleros-sdk/src/graphql/fragment-masking.ts |
Introduced utilities for handling GraphQL fragments, including FragmentType, useFragment, makeFragmentData, and isFragmentReady. |
kleros-sdk/src/graphql/gql.ts |
Introduced a centralized mapping for GraphQL operations with a documents object and a graphql function for type-safe queries. |
kleros-sdk/src/graphql/index.ts |
Re-exported all entities from fragment-masking and gql modules. |
kleros-sdk/src/index.ts |
Re-exported all entities from the ./sdk module. |
kleros-sdk/test/dataMappings.test.ts |
Updated import paths to use a tilde prefix, enhanced type safety in test cases, and modified assertions for mappings. |
kleros-sdk/test/disputeDetailsSchema.test.ts |
Updated import path for disputeDetailsSchema to use a tilde prefix. |
kleros-sdk/tsconfig-cjs.json |
Introduced a new TypeScript configuration file for CommonJS module system. |
kleros-sdk/tsconfig.json |
Modified base configuration, updated output directory, and adjusted compiler options. |
tsconfig/base.json |
Updated target, module, and moduleResolution properties, and added lib property. |
Sequence Diagram(s)
sequenceDiagram
participant User
participant SDK
participant GraphQL
User->>SDK: Initiate Action
SDK->>GraphQL: Fetch Data
GraphQL-->>SDK: Return Data
SDK-->>User: Return ResultPossibly related PRs
- #1702: Involves renaming properties related to user voting metrics, which aligns with updates in dispute templates and data mappings.
Suggested reviewers
- alcercu
Poem
🐰 In the meadow where changes bloom,
A new path for our code to zoom.
With types so clear and imports bright,
Kleros SDK takes a flight!
From disputes to actions, all in sync,
Hop along, let’s make it link! 🌼
netlify[bot]
codeclimate[bot]
jaybuidl
PR-Codex overview
This PR primarily focuses on restructuring and enhancing the
kleros-sdkproject by updating type definitions, improving type safety, and modifying the GraphQL integration. It also updates configuration files and modifies various action imports for better clarity and organization.Detailed summary
DisputeRequesttype indisputeRequest.ts.dataMappingTypes.tsto enhance mapping types.~for better clarity.executeActionto utilizeDataMappingandDisputeRequest.graphqlintegration ingraphql/index.ts.arbitratorChainIDinDisputeTemplate.json.mustache.tsconfigfiles for better module resolution.package.jsonto2.0.1-3.Summary by CodeRabbit
New Features
arbitratorChainIDin dispute templates to improve compatibility.Bug Fixes
Documentation
Chores