geoffodonnell / dotnet-tinyman-sdk

Tinyman .NET SDK

dotnet-tinyman-sdk

Overview

This library provides access to the Tinyman AMM on the Algorand blockchain.

Release Notes

• v2.2.0.1
  • Updates Algorand SDK to 2.0.0.*; updates other dependencies
• v2.1.0.1
  • Adds support for re-keyed accounts
• v2.0.0.1
  • Adds support for Tinyman V2
  • Significant refactor; removes 'Action' classes
• v1.0.0.2
  • Updates Algorand SDK to 1.0.0.15; target net6.0

Known Issues

High Severity

• The V1 pools should NOT be used as they are vulnerable to a liquidity draining attack.
  • See the announcement here for more information.

Installation

Releases are available at nuget.org.

Package Manager

PM> Install-Package -Id Tinyman

.NET CLI

dotnet add package Tinyman

Getting Started

Other than initializing a client instance, no specific setup is required. However, if your application generates a high volume of requests it is suggested that you setup your own Algod node. See the links below for more information:

• Algorand node on Linux/Mac
• Algorand node on Windows

Notes

Default clients connect to Algod nodes maintained by AlgoNode.io (Thanks AlgoNode!). It's important that your application handle rate limiting (HTTP 429) responses by decreasing the frequency of requests. See this guide for a discussion on the topic.

Usage

Swapping

Swap one asset for another in an existing pool.

// Initialize the client
var client = new TinymanV2TestnetClient(); // or TinymanV1TestnetClient();

// Get the assets
var tinyUsdc = await client.FetchAssetAsync(21582668);
var algo = await client.FetchAssetAsync(0);

// Get the pool
var pool = await client.FetchPoolAsync(algo, tinyUsdc);

// Get a quote to swap 1 Algo for tinyUsdc
var amountIn = Algorand.Utils.Utils.AlgosToMicroalgos(1.0);
var quote = pool.CalculateFixedInputSwapQuote(new AssetAmount(algo, amountIn), 0.005);

// Perform the swap
var result = await client.SwapAsync(account, quote);

Minting

Add assets to an existing pool in exchange for the liquidity pool asset.

// Initialize the client
var client = new TinymanV2TestnetClient(); // or TinymanV1TestnetClient();

// Get the assets
var tinyUsdc = await client.FetchAssetAsync(21582668);
var algo = await client.FetchAssetAsync(0);

// Get the pool
var pool = await client.FetchPoolAsync(algo, tinyUsdc);

// Get a quote to add 1 Algo and the corresponding tinyUsdc amount to the pool
var amountIn = Algorand.Utils.Utils.AlgosToMicroalgos(1.0);
var quote = pool.CalculateMintQuote(new AssetAmount(algo, amountIn), 0.005);

// Perform the minting
var result = await client.MintAsync(account, quote);

Burning

Exchange the liquidity pool asset for the pool assets.

// Initialize the client
var client = new TinymanV2TestnetClient(); // or TinymanV1TestnetClient();

// Get the assets
var tinyUsdc = await client.FetchAssetAsync(21582668);
var algo = await client.FetchAssetAsync(0);

// Get the pool
var pool = await client.FetchPoolAsync(algo, tinyUsdc);

// Get a quote to swap the entire liquidity pool asset balance for pooled assets
var amount = client.GetBalance(account.Address, pool.LiquidityAsset);
var quote = pool.CalculateBurnQuote(amount, 0.005);

// Perform the burning
var result = await client.BurnAsync(account, quote);

Redeeming (V1 only)

Redeem excess amounts from previous transactions.

// Initialize the client
var client = new TinymanV1TestnetClient();

// Fetch the amounts
var excessAmounts = await client.FetchExcessAmountsAsync(account.Address);

// Redeem each amount
foreach (var quote in excessAmounts) {
	var result = await client.RedeemAsync(account, quote);
}

Examples

Full examples, simple and verbose, can be found in /example.

Build

dotnet-tinyman-sdk build pipelines use the Assembly Info Task extension.

License

dotnet-tinyman-sdk is licensed under a MIT license except for the exceptions listed below. See the LICENSE file for details.

Exceptions

src\Tinyman\V1\asc.json is currently unlicensed. It may be used by this SDK but may not be used in any other way or be distributed separately without the express permission of Tinyman. It is used here with permission.

Disclaimer

Nothing in the repo constitutes professional and/or financial advice. Use this SDK at your own risk.

dotnet-tinyman-sdk's Issues

Possible MintQuote Bug - Checking both asset amounts are equal in case of new mint

In case the liquidity is 0, the code compares the input asset amounts instead of checking that they are non null values.

https://github.com/geoffodonnell/dotnet-tinyman-sdk/blob/main/src/Tinyman/V1/Model/PoolExtensions.cs#L183

// Pool exists does not contain assets
} else {

if (amount1 != amount2) {
	throw new Exception("Amounts required for both assets for first mint!");
}

liquidityAssetAmount = Convert.ToUInt64(
	Math.Sqrt((double)BigInteger.Multiply(amount1.Amount, amount2.Amount)) - 1000);
slippage = 0;
}

Will there be dotnet core version?

Unless .NET actually means .NET core?

.NET 5 is the next major release of .NET Core following 3.1. We named this new release .NET 5 instead of .NET Core 4
https://docs.microsoft.com/en-us/dotnet/core/whats-new/dotnet-5

If not, wondering if it's easy to port over to core or if it's fairly simple to run dotnet in Linux. Thanks for all this!

Pool token unit name for V1_1 bootstrapping

The unit name for pool in bootstrapping is set to TM1POOL11 instead of TMPOOL11

if (validatorAppId == Constant.TestnetValidatorAppIdV1_0 ||
				validatorAppId == Constant.MainnetValidatorAppIdV1_0) {
				unitName = "TM1POOL";
				name = $"Tinyman Pool {asset1.UnitName}-{asset2.UnitName}";
			} else {
				unitName = "TM1POOL11";
				name = $"TinymanPool1.1 {asset1.UnitName}-{asset2.UnitName}";
			}

Python sdk - https://github.com/tinymanorg/tinyman-py-sdk/blob/v1-1-updates/tinyman/v1/bootstrap.py#L40

Bad Request - Malformed Algorand transaction

Every time I am running the swap example it throws "Bad Request - Malformed Algorand transaction".

Thank you in advance.

FetchAssetAsync uses FetchAssetFromApiAsync

Hi,

there is issue with FetchAssetAsync. The algod has dropped support for asa fetch from the api, and was transformed only for use by the indexer.

https://algoexplorer.io/api-dev/v2

if tinymanMainnetClient.FetchAssetAsync returns 403, it means your algod does not support it any longer.

i am afraid the only solution is to add the indexer to the library

Error while deserailzation

Looks like algorand api are no longer returning "creator" field for assets. This fields is required, so all tinyman api like GetBalance, FetchAssets are failing.