Alammex-Python-SDK

Alammex Python SDK for fetching

• Alammex quote for a swap
• the transaction group to execute a given Alammex quote

Installation

Run: pip install git+https://github.com/PhilGabardo/Alammex-Python-SDK

Fetch Alammex Quote

To fetch an Alammex quote, initialize the client and use:

• get_fixed_input_swap_quote for a fixed input swap
• get_fixed_output_swap_quote for a fixed output swap

Example (for fixed input):

from algosdk.v2client import algod
import algosdk
import msgpack


from alammex.v1.alammex_client import AlammexTestnetClient

senderAddress = 'DWQXOZMGDA6QZRSPER6O4AMTO3BQ6CEJMFO25EWRRBK72RJO54GLDCGK4E'
senderPk = algosdk.mnemonic.to_private_key('bottom stone elegant just symbol bunker review curve laugh burden jewel pepper replace north tornado alert relief wrist better property spider picture insect abandon tuna')

algodUri = 'https://testnet-algorand.api.purestake.io/ps2'
algodToken = {
	'X-API-Key': '<INSERT_PURESTAKE_KEY>'
}
algodPort = ''
apiKey = '' # reach out to [email protected] to get custom API key with higher rate limit
algod = algod.AlgodClient(algodToken['X-API-Key'], algodUri, algodToken)
params = algod.suggested_params()
inputAssetId = 0
outputAssetId = 10458941
amount = 1000000

client = AlammexTestnetClient(algodUri, algodToken, algodPort, apiKey)
quote = client.get_fixed_input_swap_quote(inputAssetId, outputAssetId, amount)
requiredAppOptIns = quote.requiredAppOptIns

accountInfo = algod.account_info(senderAddress)
appsLocalState = accountInfo['apps-local-state']

# opt into required apps for swap
for requiredAppOptIn in requiredAppOptIns:
	requiredAppLocalState = [appLocalState['id'] == requiredAppOptIn for appLocalState in appsLocalState]
	if len(requiredAppLocalState) == 0:
		appOptIn = algosdk.future.transaction.ApplicationOptInTxn(senderAddress, params, requiredAppOptIn)
		signedAppOptIn = appOptIn.sign(senderPk)
		algod.send_transaction(signedAppOptIn)

Fetch Transaction Group for Executing Alammex Quote

To fetch the transaction group for executing an Alammex quote, use get_swap_quote_transactions.

Example (using quote from example above):

...

slippage = 5
referrer = ''

txnGroup = client.get_swap_quote_transactions(
	senderAddress,
	quote,
	slippage,
	referrer
)

signedTxns = []
for txn in txnGroup.txns:
	if txn.logicSigBlob:
		signedTxns.append(msgpack.unpackb(txn.logicSigBlob))
	else:
		txnObj = algosdk.encoding.future_msgpack_decode(txn.data)
		signedTxns.append(txnObj.sign(senderPk))

txId = algod.send_transactions(signedTxns)

print(txId)