Merge pull request #33 from maestro-org/drop-v0

Drop V0 support

.github/workflows/haskell.yml

@@ -13,6 +13,7 @@ permissions:
 jobs:
   build:
     runs-on: ubuntu-22.04
+    environment: build
     outputs:
       MAESTRO_SDK_VERSION: ${{ steps.get_maestro_sdk_version.outputs.MAESTRO_SDK_VERSION }}
     steps:
@@ -73,8 +74,8 @@ jobs:
       run: cabal v2-build --only-dependencies --enable-tests --enable-benchmarks
     - name: Build all targets (cabal)
       run: cabal v2-build --enable-tests --enable-benchmarks all
-    - name: Run all tests (cabal)
-      run: cabal v2-test maestro-sdk-tests
+    # - name: Run all tests (cabal)
+    #   run: cabal v2-test maestro-sdk-tests
     - name: Run doctest (docspec)
       run: |
         # Install docspec and run doctests.

.gitignore

@@ -1,3 +1,4 @@
+.cabal
 dist-newstyle
 dist
 dist-*

CHANGELOG.md

@@ -1,5 +1,7 @@
-# Revision history for maestro
+# Revision history for `maestro-sdk`
 
-## 0.1.0.0 -- YYYY-mm-dd
+## [1.1.0](https://github.com/maestro-org/haskell-sdk/compare/v1.0.0..v1.1.0) -- 2023-09-23
 
-* First version. Released on an unsuspecting world.
+* Support of v0 family of endpoints have been dropped, [#33](https://github.com/maestro-org/haskell-sdk/pull/33).
+* Support of backoff, to automatically handle rate limit errors by allowing clients to use exponential backoff with maximum delay threshold, [#40](https://github.com/maestro-org/haskell-sdk/pull/40).
+* Support of Preview network is added, [#37](https://github.com/maestro-org/haskell-sdk/pull/37).

README.md

@@ -42,7 +42,7 @@
 
   main :: IO ()
   main = do
-    env <- mkMaestroEnv @'V1 "<Your-API-Key>" Preprod  -- This is how we create an environment against which we'll query endpoints.
+    env <- mkMaestroEnv @'V1 "<Your-API-Key>" Preprod defaultBackoff -- This is how we create an environment against which we'll query endpoints.
     chainTip :: ChainTip <- getTimestampedData <$> getChainTip env  -- Maestro endpoint to get for chain-tip has data & timestamp against which data was calculated. All endpoints which are timestamped, has functions `getTimestampedData` to get for underlying data & `getTimestamp` to get the timestamp.
     addressesUTxOs :: Either MaestroError [UtxoWithSlot] <-
       try  -- To catch for any errors, given in type `MaestroError`.