Merge branch 'main' of github.com:centrifuge/centrifuge-sdk into more-reports

Author: sophialittlejohn

.c8rc.json

@@ -0,0 +1,8 @@
+{
+  "all": true,
+  "include": ["src/**/*.ts"],
+  "exclude": ["src/**/*.d.ts", "src/**/*.test.ts", "src/types/*.ts", "src/tests/**/*.ts"],
+  "reporter": ["text", "lcov"],
+  "extension": [".ts"],
+  "report-dir": "./coverage"
+} 

.github/workflows/build-test-report.yml

@@ -34,9 +34,7 @@ jobs:
         run: yarn build
 
       - name: Run tests
-        run: |
-          yarn test:ci
-          yarn test:coverage
+        run: yarn test:coverage
         env:
           TENDERLY_ACCESS_KEY: ${{ secrets.TENDERLY_ACCESS_KEY }}
           PROJECT_SLUG: ${{ secrets.PROJECT_SLUG }}
@@ -50,6 +48,7 @@ jobs:
           name: test-results
           path: |
             report/
+            coverage/lcov-report/
           retention-days: 15
 
       - name: Upload coverage to Codecov
@@ -58,5 +57,5 @@ jobs:
           directory: ./coverage
           token: ${{ secrets.CODECOV_TOKEN }}
           # flags: unittests
-          name: sdk-coverage-with-nyc
+          name: sdk-coverage
           fail_ci_if_error: true          

.github/workflows/create-release.yml

@@ -29,4 +29,4 @@ jobs:
           --title "Release v${VERSION}" \
           --generate-notes \
           --prerelease \
-          --draft
+          --target "${COMMIT_SHA}"

.github/workflows/naming-conventions.yml

@@ -40,10 +40,6 @@ jobs:
       pull-requests: write
       contents: read
     steps:
-      - name: Debug outputs from title-n-label-check
-        run: |
-          echo "Title Error: ${{ needs.title-n-label-check.outputs.title_error }}"
-          echo "Labels Valid: ${{ needs.title-n-label-check.outputs.labels_valid }}"
 
       - name: Find existing PR title error comment
         uses: peter-evans/find-comment@v2

.gitignore

@@ -26,5 +26,4 @@ yarn-error.log
 # Tests and coverage
 coverage/
 test-results.xml
-.nyc_output
 report/

.nycrc

@@ -1,20 +1,15 @@
-[![Codecov](https://codecov.io/gh/centrifuge/sdk/graph/badge.svg?token=Q2yU8QfefP)](https://codecov.io/gh/centrifuge/sdk)
-[![Build CI status](https://github.com/centrifuge/sdk/actions/workflows/build-test-report.yml/badge.svg)](https://github.com/centrifuge/sdk/actions/workflows/build-test-report.yml)
+# Centrifuge SDK [![Codecov](https://codecov.io/gh/centrifuge/sdk/graph/badge.svg?token=Q2yU8QfefP)](https://codecov.io/gh/centrifuge/sdk) [![Build CI status](https://github.com/centrifuge/sdk/actions/workflows/build-test-report.yml/badge.svg)](https://github.com/centrifuge/sdk/actions/workflows/build-test-report.yml) [![Latest Release](https://img.shields.io/github/v/release/centrifuge/sdk?sort=semver)](https://github.com/centrifuge/sdk/releases/latest)
 
-<!-- [![npm version](https://badge.fury.io/js/@centrifuge%2Fsdk.svg)](https://www.npmjs.com/package/@centrifuge/sdk) -->
-
-[![Latest Release](https://img.shields.io/github/v/release/centrifuge/sdk?sort=semver)](https://github.com/centrifuge/sdk/releases/latest)
-
-# Centrifuge JavaScript SDK
-
-CentrifugeSDK provides a JavaScript client to interact with the Centrifuge ecosystem. It provides a comprehensive interface to easily create and manage pools, nfts, loans and metadata.
+The Centrifuge SDK is a JavaScript client for interacting with the [Centrifuge](https://centrifuge.io) ecosystem. It provides a comprehensive, fully typed library to integrate investments and redemptions, generate financial reports, manage pools, and much more.
 
 ## Installation
 
-CentrifugeSDK uses [Viem](https://viem.sh/) under the hood. It's necessary to install it alongside the SDK.
+Centrifuge SDK uses [Viem](https://viem.sh/) under the hood. It's necessary to install it alongside the SDK.
 
 ```bash
 npm install --save @centrifuge/sdk viem
+# or
+yarn install @centrifuge/sdk viem
 ```
 
 ## Init and config
@@ -27,7 +22,7 @@ import Centrifuge from '@centrifuge/sdk'
 const centrifuge = new Centrifuge()
 ```
 
-The following config options can be passed on initilization of CentrifugeSDK:
+The following config options can be passed on initialization of the SDK:
 
 - `environment: 'mainnet' | 'demo' | 'dev'`
   - Optional
@@ -66,7 +61,7 @@ To perform transactions, you need to set a signer on the `centrifuge` instance.
 centrifuge.setSigner(signer)
 ```
 
-`signer` can be a [EIP1193](https://eips.ethereum.org/EIPS/eip-1193)-compatible provider or a Viem [LocalAccount](https://viem.sh/docs/accounts/local)
+`signer` can be a [EIP1193](https://eips.ethereum.org/EIPS/eip-1193)-compatible provider or a Viem [LocalAccount](https://viem.sh/docs/accounts/local).
 
 With this you can call transaction methods. Similar to queries they can be awaited to get their final result, or subscribed to get get status updates.
 

README.md

@@ -33,7 +33,7 @@
     "test:simple:single": "mocha --loader=ts-node/esm --exit --timeout 60000",
     "test:single": "mocha --loader=ts-node/esm --require $(pwd)/src/tests/setup.ts --exit --timeout 60000",
     "test:ci": "yarn test --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json",
-    "test:coverage": "nyc yarn test"
+    "test:coverage": "c8 yarn test:ci"
   },
   "dependencies": {
     "decimal.js-light": "^2.5.1",
@@ -47,6 +47,7 @@
     "@types/node": "^22.7.8",
     "@types/sinon": "^17.0.3",
     "@types/sinon-chai": "^4",
+    "c8": "^10.1.2",
     "chai": "^5.1.2",
     "dotenv": "^16.4.5",
     "eslint": "^9.12.0",
@@ -55,7 +56,6 @@
     "mocha-multi-reporters": "^1.5.1",
     "mochawesome": "^7.1.3",
     "npm-run-all": "4.1.5",
-    "nyc": "^17.1.0",
     "prettier": "^3.3.3",
     "sinon": "^19.0.2",
     "sinon-chai": "^4.0.0",