Author: github-actions[bot]

.github/actions/setup-subtopia-registry/action.yaml

@@ -29,10 +29,11 @@ runs:
         ssh-key: ${{ inputs.ssh-key }}
         repository: ${{ inputs.repository }}
         path: ${{ inputs.path }}
+        ref: main
         fetch-depth: 1
 
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ inputs.python-version }}
 

.github/workflows/cicd.yaml

@@ -135,7 +135,7 @@ jobs:
     if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/release'
     permissions: write-all
     name: Release
-    needs: [build, lint, unit-tests, deploy-docs]
+    needs: [build, lint, unit-tests]
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository

.gitignore

@@ -32,3 +32,9 @@ coverage
 docs
 
 .env
+
+debug_traces/
+
+.algokit/
+
+.algokit.toml

.prettierignore

@@ -0,0 +1,10 @@
+# .prettierignore
+node_modules
+dist
+dist-ssr
+*.log
+coverage
+debug_traces
+*.local
+docs
+changelog.md

CHANGELOG.md

@@ -1,16 +1,36 @@
-# [1.1.0](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v1.0.1...v1.1.0) (2024-01-05)
+# [2.0.0-beta.4](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v2.0.0-beta.3...v2.0.0-beta.4) (2024-01-21)
+
+# [2.0.0-beta.3](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v2.0.0-beta.2...v2.0.0-beta.3) (2024-01-21)
+
+# [2.0.0-beta.2](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v2.0.0-beta.1...v2.0.0-beta.2) (2024-01-20)
+
+# [2.0.0-beta.1](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v1.1.0...v2.0.0-beta.1) (2024-01-17)
 
 
 ### Features
 
-* new method for fetching all subscribers from a product instance ([#38](https://github.com/subtopia-algo/subtopia-js-sdk/issues/38)) ([8fc14db](https://github.com/subtopia-algo/subtopia-js-sdk/commit/8fc14dbdaa2e6d04fb4f470a65d472fbfe3a8b72))
+* refactoring contracts to support latest 'token-based' types ([#39](https://github.com/subtopia-algo/subtopia-js-sdk/issues/39)) ([604becc](https://github.com/subtopia-algo/subtopia-js-sdk/commit/604beccc4fc2800b4859368aebf3228b6122dd8f))
 
-## [1.0.1](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v1.0.0...v1.0.1) (2023-12-13)
 
+### BREAKING CHANGES
+
+* Deprecating interface for old contracts, adding a refined and more flexible setup with Token Based subscriptions.
+
+* refactor: improving project structure; minor refinements
+
+* chore: testing ci
+
+# [1.1.0](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v1.0.1...v1.1.0) (2024-01-05)
+
+### Features
+
+- new method for fetching all subscribers from a product instance ([#38](https://github.com/subtopia-algo/subtopia-js-sdk/issues/38)) ([8fc14db](https://github.com/subtopia-algo/subtopia-js-sdk/commit/8fc14dbdaa2e6d04fb4f470a65d472fbfe3a8b72))
+
+## [1.0.1](https://github.com/subtopia-algo/subtopia-js-sdk/compare/v1.0.0...v1.0.1) (2023-12-13)
 
 ### Bug Fixes
 
-* bug fixing the renewal flow ([#34](https://github.com/subtopia-algo/subtopia-js-sdk/issues/34)) ([c04285b](https://github.com/subtopia-algo/subtopia-js-sdk/commit/c04285b654c80ae58e7866ab5c98a3c98e04128d))
+- bug fixing the renewal flow ([#34](https://github.com/subtopia-algo/subtopia-js-sdk/issues/34)) ([c04285b](https://github.com/subtopia-algo/subtopia-js-sdk/commit/c04285b654c80ae58e7866ab5c98a3c98e04128d))
 
 # 1.0.0 (2023-11-30)
 

README.md

@@ -39,11 +39,7 @@ yarn add subtopia-js-sdk
 ### Import the package:
 
 ```ts
-import {
-  SubtopiaClient,
-  SubtopiaRegistryClient,
-  ChainType,
-} from "subtopia-js-sdk";
+import { SubtopiaClient, SubtopiaRegistryClient } from "subtopia-js-sdk";
 ```
 
 ## 🛠️ Usage
@@ -55,18 +51,24 @@ Example snippets of using the Subtopia JS SDK.
 ### Purchasing a subscription:
 
 ```ts
+import {
+  SubtopiaClient,
+  SubtopiaRegistryClient,
+  ChainType,
+  SUBTOPIA_REGISTRY_ID
+} from "subtopia-js-sdk";
 // ... your code
 
 const subtopiaClient = await SubtopiaClient.init({
   algodClient: PUT_ALGOD_INSTANCE_HERE,
   chainType: PUT_CHAIN_TYPE_ENUM_HERE // 'testnet'|'mainnet'|'localnet'
   productID: PUT_PRODUCT_ID_HERE,
+  registryID: SUBTOPIA_REGISTRY_ID(ChainType.{YOUR_CHAIN_TYPE_HERE}),
   creator: { addr: PUT_WALLET_ADDRESS, signer: PUT_WALLET_SIGNER },
 });
 
 const response = await subtopiaClient.createSubscription(
-  { addr: PUT_WALLET_ADDRESS, signer: PUT_WALLET_SIGNER },
-  PUT_DURATION_HERE // pick duration from Duration enum. If there is a discount available for this duration, it will be auto applied.
+  { subscriber: { addr: PUT_WALLET_ADDRESS, signer: PUT_WALLET_SIGNER } },
 );
 
 console.log(response.txID); // response is of type string
@@ -80,6 +82,7 @@ console.log(response.txID); // response is of type string
 // ... your code
 const subscriptionRecord = await subtopiaClient.getSubscription({
   subscriberAddress: PUT_SUBSCRIBER_ADDRESS,
+  algodClient: PUT_ALGOD_INSTANCE_HERE,
 });
 
 // SubscriptionRecord (throws Error if not subscribed)
@@ -91,11 +94,12 @@ console.log(subscriptionRecord);
 
 ```ts
 // ... your code
-const deleteResult = await subtopiaClient.unsubscribe({
+const deleteResult = await subtopiaClient.deleteSubscription({
   subscriber: {
     addr: PUT_SUBSCRIBER_ADDRESS,
     signer: PUT_SUBSCRIBER_SIGNER,
   },
+  subscriptionID: PUT_SUBSCRIPTION_ID,
 });
 
 // Transaction ID of the unsubscribe transaction
@@ -135,8 +139,6 @@ const subtopiaRegistryClient = await SubtopiaRegistryClient.init({
 });
 
 const discount = await subtopiaRegistryClient.createDiscount({
-  productID: PUT_PRODUCT_ID_HERE, // number - the ID of the Product instance you want to create a discount for
-  duration: PUT_DURATION_HERE, // number - the type of duration to apply. Also serves as static id for the discount.
   discountType: PUT_DISCOUNT_TYPE_HERE, // number - the type of discount to apply. FIXED or PERCENTAGE
   discountValue: PUT_DISCOUNT_VALUE_HERE, // number - the discount to be deducted from the subscription price
   expiresIn: PUT_EXPIRATION_TIME_HERE, // (Optional) Set 0 for discount to never expire. Else set number of seconds to append to unix timestamp at time of creation.
@@ -152,12 +154,9 @@ console.log(discount.txID); // response is of type string
 ```ts
 // ... your code
 
-const discount = await subtopiaRegistryClient.getDiscount(
-  productID: PUT_PRODUCT_ID_HERE,
-  duration: PUT_DURATION_HERE,
-);
+const discount = await subtopiaClient.getDiscount();
 
-// DiscountRecord (throws Error if not found)
+// DiscountRecord (throws Error if no active discount)
 console.log(discount);
 // ... rest of your code
 ```
@@ -167,10 +166,7 @@ console.log(discount);
 ```ts
 // ... your code
 
-const deleteResult = await subtopiaRegistryClient.deleteDiscount({
-  productID: PUT_PRODUCT_ID,
-  duration: PUT_DURATION_HERE,
-});
+const deleteResult = await subtopiaRegistryClient.deleteDiscount();
 
 // Transaction ID of the delete discount transaction
 console.log(deleteResult.txID);

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "subtopia-js-sdk",
-  "version": "1.1.0",
+  "version": "2.0.0-beta.4",
   "description": "Subtopia SDK for JavaScript",
   "main": "dist/index.cjs.js",
   "module": "dist/index.es.js",
@@ -28,14 +28,14 @@
     "pre-commit": "npm run lint:scripts && npm run format:scripts && npm run test:integration && npm run build && npm run docs"
   },
   "peerDependencies": {
-    "@algorandfoundation/algokit-utils": "^5.0.0",
+    "@algorandfoundation/algokit-utils": "5.0.1",
     "algosdk": "^2.7.0"
   },
   "devDependencies": {
     "@feki.de/semantic-release-yarn": "1.0.1",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@types/node": "^18.13.0",
+    "@types/node": "^20.0.0",
     "@types/react": "^18.0.26",
     "@types/react-dom": "^18.0.9",
     "@typescript-eslint/eslint-plugin": "^5.46.0",