Merge pull request #21 from SundaeSwap-finance/calvin/taste-tests

Introduce Taste Test Package
SundaeSwap-finance · Oct 12, 2023 · 33172b4 · 33172b4
2 parents ce71014 + 6de530b
commit 33172b4
Show file tree

Hide file tree

Showing 42 changed files with 957 additions and 87 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,2 +1,5 @@
 {
-}
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": "always"
+  }
+}
diff --git a/README.md b/README.md
@@ -13,15 +13,15 @@ Sundae-SDK is a TypeScript library for building transactions for the SundaeSwap
 First, install the relevant packages:
 
 ```console
-$ yarn add lucid-cardano @sundaeswap/sdk-core
+$ yarn add lucid-cardano @sundaeswap/core
 ```
 Then start using the SDK:
 ```typescript
-import { SundaeSDK } from "@sundaeswap/sdk-core";
+import { SundaeSDK } from "@sundaeswap/core";
 import {
  TxBuilderLucid,
  ProviderSundaeSwap
-} from "@sundaeswap/sdk-core/extensions";
+} from "@sundaeswap/core/extensions";
 
 const txBuilder = new TxBuilderLucid(
  {

diff --git a/docs/index.md b/docs/index.md
@@ -9,4 +9,5 @@ packages will follow, but we plan to support popular libraries like [TypeScript]
 
 ## TypeScript
 
-- [@sundaeswap/sdk-core](./typescript/core/modules.html)
+- [@sundaeswap/core](./typescript/core/modules.html)
+- [@sundaeswap/taste-test](./typescript/taste-test/modules.html)
diff --git a/docs/typescript/core/classes/Extensions.TxBuilderLucid.md b/docs/typescript/core/classes/Extensions.TxBuilderLucid.md
@@ -49,7 +49,7 @@ TxBuilder&lt;
 
 #### Defined in
 
-[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:96](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L96)
+[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:95](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L95)
 
 ## Methods
 
@@ -76,7 +76,7 @@ that allows a user to add or update staking positions.
 
 #### Defined in
 
-[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:189](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L189)
+[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:188](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L188)
 
 ___
 
@@ -105,7 +105,7 @@ with an updated swap datum.
 
 #### Defined in
 
-[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:355](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L355)
+[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:354](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L354)
 
 ___
 
@@ -141,7 +141,7 @@ Initializes a Lucid instance with the
 
 #### Defined in
 
-[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:114](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L114)
+[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:113](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L113)
 
 ___
 
@@ -167,4 +167,4 @@ Returns a new Tx instance from Lucid. Throws an error if not ready.
 
 #### Defined in
 
-[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:148](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L148)
+[classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts:147](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts#L147)
diff --git a/docs/typescript/core/index.md b/docs/typescript/core/index.md
@@ -13,15 +13,15 @@ Sundae-SDK is a TypeScript library for building transactions for the SundaeSwap
 First, install the relevant packages:
 
 ```console
-$ yarn add lucid-cardano @sundaeswap/sdk-core
+$ yarn add lucid-cardano @sundaeswap/core
 ```
 Then start using the SDK:
 ```typescript
-import { SundaeSDK } from "@sundaeswap/sdk-core";
+import { SundaeSDK } from "@sundaeswap/core";
 import {
  TxBuilderLucid,
  ProviderSundaeSwap
-} from "@sundaeswap/sdk-core/extensions";
+} from "@sundaeswap/core/extensions";
 
 const txBuilder = new TxBuilderLucid(
  {

diff --git a/docs/typescript/core/interfaces/Core.ITxBuilderBaseOptions.md b/docs/typescript/core/interfaces/Core.ITxBuilderBaseOptions.md
@@ -21,7 +21,7 @@ Whether to allow debugging console logs.
 
 #### Defined in
 
-[@types/txbuilder.ts:61](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L61)
+[@types/txbuilder.ts:62](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L62)
 
 ___
 
@@ -33,7 +33,7 @@ The minimum amount of ADA required for a locking position.
 
 #### Defined in
 
-[@types/txbuilder.ts:59](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L59)
+[@types/txbuilder.ts:60](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L60)
 
 ___
 
@@ -45,7 +45,7 @@ A supported Cardano network.
 
 #### Defined in
 
-[@types/txbuilder.ts:57](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L57)
+[@types/txbuilder.ts:58](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L58)
 
 ___
 
@@ -57,4 +57,4 @@ A CIP-30 compatible wallet.
 
 #### Defined in
 
-[@types/txbuilder.ts:55](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L55)
+[@types/txbuilder.ts:56](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L56)
diff --git a/docs/typescript/core/interfaces/Extensions.ITxBuilderLucidOptions.md b/docs/typescript/core/interfaces/Extensions.ITxBuilderLucidOptions.md
@@ -43,7 +43,7 @@ Whether to allow debugging console logs.
 
 #### Defined in
 
-[@types/txbuilder.ts:61](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L61)
+[@types/txbuilder.ts:62](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L62)
 
 ___
 
@@ -59,7 +59,7 @@ The minimum amount of ADA required for a locking position.
 
 #### Defined in
 
-[@types/txbuilder.ts:59](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L59)
+[@types/txbuilder.ts:60](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L60)
 
 ___
 
@@ -75,7 +75,7 @@ A supported Cardano network.
 
 #### Defined in
 
-[@types/txbuilder.ts:57](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L57)
+[@types/txbuilder.ts:58](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L58)
 
 ___
 
@@ -103,4 +103,4 @@ A CIP-30 compatible wallet.
 
 #### Defined in
 
-[@types/txbuilder.ts:55](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L55)
+[@types/txbuilder.ts:56](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/packages/core/src/@types/txbuilder.ts#L56)
diff --git a/docs/typescript/core/modules.md b/docs/typescript/core/modules.md
@@ -1,4 +1,4 @@
-# @sundaeswap/sdk-core
+# @sundaeswap/core
 
 ## Modules
 

diff --git a/docs/typescript/core/modules/Core.md b/docs/typescript/core/modules/Core.md
@@ -1,14 +1,14 @@
 # Module: Core
 
 # Introduction
-The `@sundaeswap/sdk-core` package serves as the foundation for interacting with the SundaeSwap protocol in a predictable and declarative manner,
+The `@sundaeswap/core` package serves as the foundation for interacting with the SundaeSwap protocol in a predictable and declarative manner,
 and includes all typings and class interfaces needed to both [Get Started](#get-started) and extending the API.
 
 ## Get Started
 To start with [Lucid](https://www.npmjs.com/package/lucid-cardano), install dependencies:
 
 ```sh
-yarn add lucid-cardano @sundaeswap/sdk-core
+yarn add lucid-cardano @sundaeswap/core
 ```
 
 If you plan to use this package in the browser along with Webpack 5, you'll need to add
@@ -25,11 +25,11 @@ plugins: {
 Next, configure the instance in your app:
 
 ```ts
-import { SundaeSDK } from "@sundaeswap/sdk-core";
+import { SundaeSDK } from "@sundaeswap/core";
 import {
  TxBuilderLucid,
  ProviderSundaeSwap
-} from "@sundaeswap/sdk-core/extensions";
+} from "@sundaeswap/core/extensions";
 
 const txBuilder = new TxBuilderLucid(
  {

diff --git a/docs/typescript/taste-test/index.md b/docs/typescript/taste-test/index.md
@@ -0,0 +1,50 @@
+# Sundae-SDK
+
+[![Licence](https://img.shields.io/github/license/SundaeSwap-finance/sundae-sdk)](https://github.com/SundaeSwap-finance/sundae-sdk/blob/main/LICENSE)
+
+Sundae-SDK is a TypeScript library for building transactions for the SundaeSwap DEX on Cardano.
+
+> :warning: **This is a pre-release package**: until we release v1.0.0, the interface may change as we identify the optimal usage patterns.
+
+## QuickStart
+
+### Getting started
+
+First, install the relevant packages:
+
+```console
+$ yarn add lucid-cardano @sundaeswap/core
+```
+Then start using the SDK:
+```typescript
+import { SundaeSDK } from "@sundaeswap/core";
+import {
+ TxBuilderLucid,
+ ProviderSundaeSwap
+} from "@sundaeswap/core/extensions";
+
+const txBuilder = new TxBuilderLucid(
+ {
+     wallet: "eternl",
+     network: "preview",        
+     provider: "blockfrost",
+     blockfrost: {
+         url: "https://cardano-preview.blockfrost.io/api/v0",
+         apiKey: "YOUR_API_KEY"
+     }
+ },
+ new ProviderSundaeSwap("preview")
+);
+
+const sdk: SundaeSDK = new SundaeSDK(txBuilder);
+
+const txHash = await sdk.swap( /** ... */ ).then(({ submit }) => submit());
+```
+
+### How to Use
+
+Documentation is available at [https://sundaeswap-finance.github.io/sundae-sdk/](https://sundaeswap-finance.github.io/sundae-sdk/), but it is very much a work-in-progress. Feel free to open a discussion with feedback, or submit a pull request!
+
+# Contributing
+
+Want to contribute? See [CONTRIBUTING.md](CONTRIBUTING.md) to know how.
diff --git a/docs/typescript/taste-test/modules.md b/docs/typescript/taste-test/modules.md
@@ -0,0 +1,56 @@
+# @sundaeswap/taste-test
+
+# Introduction
+The `@sundaeswap/taste-test` package serves as an additional API by which clients can interact with existing SundaeSwap Taste Tests.
+
+## Get Started
+To start with [Lucid](https://www.npmjs.com/package/lucid-cardano), install dependencies:
+
+```sh
+yarn add lucid-cardano @sundaeswap/core @sundaeswap/taste-test
+```
+
+If you plan to use this package in the browser along with Webpack 5, you'll need to add
+polyfill support for Buffer. You can do this like so:
+
+```ts
+plugins: {
+  new webpack.ProvidePlugin({
+    Buffer: ["buffer", "Buffer"]
+  })
+}
+```
+
+Next, configure the instance in your app:
+
+```ts
+import {
+ TxBuilderLucid,
+ ProviderSundaeSwap
+} from "@sundaeswap/core/extensions";
+import { SundaeSDK } from "@sundaeswap/core";
+import { TasteTest } from "@sundaeswap/taste-test"
+import type { Lucid } from "lucid-cardano";
+
+const txBuilder = new TxBuilderLucid(
+ {
+     wallet: "eternl",
+     network: "preview",        
+     provider: "blockfrost",
+     blockfrost: {
+         url: "https://cardano-preview.blockfrost.io/api/v0",
+         apiKey: "YOUR_API_KEY"
+     }
+ },
+ new ProviderSundaeSwap("preview")
+);
+
+const sdk: SundaeSDK = new SundaeSDK(txBuilder);
+const walletInstance = txBuilder.build<unknown, Lucid>().wallet;
+let tt: TasteTest | undefined;
+if (walletInstance) {
+  tt = new TasteTest(txBuilder.build<unknown, Lucid>().wallet)
+}
+
+tt?.deposit({ ...args });
+```
diff --git a/jest.config.ts b/jest.config.ts
@@ -3,7 +3,7 @@ import { JestConfigWithTsJest } from "ts-jest";
 const config: JestConfigWithTsJest = {
   projects: [
     {
-      displayName: "@sundaeswap/sdk-core",
+      displayName: "@sundaeswap/core",
       testEnvironment: "node",
       testMatch: ["<rootDir>/packages/core/**/__tests__/**/*.test.*?(x)"],
       testPathIgnorePatterns: ["/dist/", "/node_modules/", "__tests__/data"],

diff --git a/lerna.json b/lerna.json
@@ -2,7 +2,7 @@
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "useNx": true,
   "useWorkspaces": true,
-  "version": "1.1.0-alpha.5",
+  "version": "independent",
   "npmClient": "yarn",
   "ignoreChanges": [
     "**/__tests__/**",
@@ -19,6 +19,9 @@
     },
     "build": {
       "ignore": "demo"
+    },
+    "test": {
+      "ignore": "demo"
     }
   }
 }
diff --git a/package.json b/package.json
@@ -13,7 +13,8 @@
     "build": "lerna run build",
     "version:ci": "lerna version -y --ignore-scripts",
     "publish:ci": "lerna publish from-package -y",
-    "docs": "lerna run docs:ci"
+    "docs": "lerna run docs:ci",
+    "dev": "concurrently \"cd packages/core && yarn watch\" \"cd packages/taste-tests && yarn watch\" \"cd packages/demo && yarn start\""
   },
   "engines": {
     "node": ">=18"
@@ -24,6 +25,7 @@
     "@sundaeswap/asset": "^0.6.9",
     "@sundaeswap/docgen": "^0.1.1",
     "@types/node": "^18.11.18",
+    "concurrently": "^8.2.1",
     "eslint": "^8.31.0",
     "glob": "^8.0.3",
     "husky": "^8.0.0",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,11 +1,11 @@
 {
-  "name": "@sundaeswap/sdk-core",
-  "version": "1.1.0-alpha.5",
+  "name": "@sundaeswap/core",
+  "version": "1.0.0-beta",
   "description": "The official SundaeSwap protocol SDK for clients.",
   "repository": "git@github.com:SundaeSwap-finance/sundae-sdk.git",
   "author": {
     "name": "SundaeSwap Labs, Inc.",
-    "url": "https://www.sundaeswap.finance/"
+    "url": "https://sundae.fi/"
   },
   "bugs": {
     "url": "https://github.com/SundaeSwap-finance/sundae-sdk/issues"

diff --git a/packages/core/src/@types/txbuilder.ts b/packages/core/src/@types/txbuilder.ts
@@ -41,9 +41,10 @@ export interface ITxBuilderReferralFee {
 export interface ITxBuilderFees {
   cardanoTxFee?: AssetAmount<IAssetAmountMetadata>;
   deposit: AssetAmount<IAssetAmountMetadata>;
-  scooperFee: AssetAmount<IAssetAmountMetadata>;
+  foldFee?: AssetAmount<IAssetAmountMetadata>;
   liquidity?: AssetAmount<IAssetAmountMetadata>;
   referral?: AssetAmount<IAssetAmountMetadata>;
+  scooperFee: AssetAmount<IAssetAmountMetadata>;
 }
 
 /**

diff --git a/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts b/packages/core/src/classes/Extensions/TxBuilders/TxBuilder.Lucid.class.ts
@@ -59,7 +59,6 @@ interface ITxBuilderLucidCompleteTxArgs {
   deposit?: bigint;
   scooperFee?: bigint;
   coinSelection?: boolean;
-  complete?: boolean;
 }
 
 /**
@@ -683,7 +682,6 @@ export class TxBuilderLucid extends TxBuilder<
     deposit,
     scooperFee,
     coinSelection,
-    complete = true,
   }: ITxBuilderLucidCompleteTxArgs): Promise<
     ITxBuilder<Tx, Datum | undefined>
   > {