Skip to content

Commit

Permalink
Merge pull request #20 from SundaeSwap-finance/feat/better-chaining-api
Browse files Browse the repository at this point in the history 
chore: update to better handle chaining
  • Loading branch information
@cjkoepke
cjkoepke authored Aug 22, 2023
2 parents 3628c75 + ca89387 commit b926aa4
Show file tree
Hide file tree
Showing 25 changed files with 256 additions and 327 deletions.
40 changes: 20 additions & 20 deletions docs/typescript/core/classes/Core.SundaeSDK.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ ___

### cancel

▸ **cancel**(`config`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **cancel**(`config`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Create a cancel transaction for an open escrow order.

Expand All @@ -79,7 +79,7 @@ Create a cancel transaction for an open escrow order.

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -89,7 +89,7 @@ ___

### deposit

▸ **deposit**(`config`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **deposit**(`config`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Create a Deposit transaction for a pool by supplying two assets.

Expand All @@ -101,7 +101,7 @@ Create a Deposit transaction for a pool by supplying two assets.

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -111,7 +111,7 @@ ___

### limitSwap

▸ **limitSwap**(`config`, `minReceivable`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **limitSwap**(`config`, `minReceivable`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Creates a swap with a minimum receivable amount.

Expand Down Expand Up @@ -148,7 +148,7 @@ const { submit, cbor } = await SDK.limitSwap(

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -158,7 +158,7 @@ ___

### lock

▸ **lock**(`config`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **lock**(`config`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Create a locking transaction for yield farming and pool delegation.

Expand All @@ -170,7 +170,7 @@ Create a locking transaction for yield farming and pool delegation.

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -196,7 +196,7 @@ ___

### swap

▸ **swap**(`config`, `slippage?`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **swap**(`config`, `slippage?`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

The main entry point for building a swap transaction with the least amount
of configuration required. By default, all calls to this method are treated
Expand Down Expand Up @@ -253,7 +253,7 @@ const { submit, cbor } = await SDK.swap(

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -263,7 +263,7 @@ ___

### unlock

▸ **unlock**(`config`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **unlock**(`config`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Create an unlocking transaction that removes all yield farming positions.

Expand All @@ -275,7 +275,7 @@ Create an unlocking transaction that removes all yield farming positions.

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -285,7 +285,7 @@ ___

### unstable\_zap

▸ **unstable_zap**(`config`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **unstable_zap**(`config`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Creates an atomic swap with a single asset and a pool.
This is experimental and currently not supported by Cardano parameter limits.
Expand All @@ -298,7 +298,7 @@ This is experimental and currently not supported by Cardano parameter limits.

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -308,7 +308,7 @@ ___

### updateSwap

▸ **updateSwap**(`cancelConfig`, `swapConfig`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **updateSwap**(`cancelConfig`, `swapConfig`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Create a new transaction that cancels and spends the assets with a new swap config.

Expand All @@ -321,7 +321,7 @@ Create a new transaction that cancels and spends the assets with a new swap conf

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -331,7 +331,7 @@ ___

### withdraw

▸ **withdraw**(`config`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **withdraw**(`config`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Create a Withdraw transaction for a pool by supplying the LP tokens.

Expand All @@ -343,7 +343,7 @@ Create a Withdraw transaction for a pool by supplying the LP tokens.

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand All @@ -353,7 +353,7 @@ ___

### zap

▸ **zap**(`config`): `Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
▸ **zap**(`config`): `Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

Builds a custom zap utilizing a chained order (first a swap, then a deposit).

Expand All @@ -365,7 +365,7 @@ Builds a custom zap utilizing a chained order (first a swap, then a deposit).

#### Returns

`Promise`<[`ITxBuilderTx`](../interfaces/Core.ITxBuilderTx.md)<`unknown`, `unknown`\>\>
`Promise`<[`ITxBuilder`](../interfaces/Core.ITxBuilder.md)<`unknown`, `unknown`\>\>

#### Defined in

Expand Down
49 changes: 0 additions & 49 deletions docs/typescript/core/classes/Core.Transaction.md
View file

This file was deleted.

Loading

0 comments on commit b926aa4

Please sign in to comment.