https://github.com/manuelmauro/algonaut

A rusty sdk for Algorand.
https://github.com/manuelmauro/algonaut

algorand blockchain crypto nft rust wasm

Last synced: 3 months ago
JSON representation

A rusty sdk for Algorand.

• Host: GitHub
• URL: https://github.com/manuelmauro/algonaut
• Owner: manuelmauro
• License: mit
• Created: 2021-03-27T14:19:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-01T17:32:36.000Z (5 months ago)
• Last Synced: 2024-04-01T21:20:52.236Z (3 months ago)
• Topics: algorand, blockchain, crypto, nft, rust, wasm
• Language: Rust
• Homepage:
• Size: 1 MB
• Stars: 63
• Watchers: 5
• Forks: 34
• Open Issues: 27
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Lists

• awesome-algorand - rust-algorand-sdk - Rust Algorand SDK. (Development Tools / Languages)

README

        


    



# Rust `algonaut`

[![Crate](https://img.shields.io/crates/v/algonaut.svg)](https://crates.io/crates/algonaut)

[![Docs](https://docs.rs/algonaut/badge.svg)](https://docs.rs/algonaut)

[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/manuelmauro/algonaut/blob/main/LICENSE)

![GitHubCI](https://github.com/manuelmauro/algonaut/actions/workflows/quickstart.yml/badge.svg)

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/manuelmauro/algonaut/tree/main.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/manuelmauro/algonaut/tree/main)

Rust **algonaut** is a rusty SDK for [Algorand](https://www.algorand.com/). Please, be aware that this crate is a work in progress.

```rust

use algonaut::algod::v2::Algod;

use algonaut_core::MicroAlgos;

use algonaut_transaction::Pay;

use algonaut_transaction::{account::Account, TxnBuilder};

use std::error::Error;

#[tokio::main]

async fn main() -> Result<(), Box> {

    let algod = Algod::new(

        "http://localhost:4001",

        "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

    )?;

    // an account with some funds

    let from_account = Account::from_mnemonic("fire enlist diesel stamp nuclear chunk student stumble call snow flock brush example slab guide choice option recall south kangaroo hundred matrix school above zero")?;

    let to_address = "2FMLYJHYQWRHMFKRHKTKX5UNB5DGO65U57O3YVLWUJWKRE4YYJYC2CWWBY".parse()?;

    // algod has a convenient method that retrieves basic information for a transaction

    let params = algod.suggested_transaction_params().await?;

    // we are ready to build the transaction

    let t = TxnBuilder::with(

        &params,

        Pay::new(from_account.address(), to_address, MicroAlgos(123_456)).build(),

    )

    .build()?;

    // we need to sign the transaction to prove that we own the sender address

    let signed_t = from_account.sign_transaction(t)?;

    // broadcast the transaction to the network

    let send_response = algod.broadcast_signed_transaction(&signed_t).await?;

    println!("Transaction ID: {}", send_response.tx_id);

    Ok(())

}

```

## Crates

- `algonaut_client` contains clients for `algod`, `kmd`, and `indexer` RPC APIs.

- `algonaut_core` defines core structures for Algorand like: `Address`, `Round`, `MicroAlgos`, etc.

- `algonaut_crypto` contains crypto utilities such as: `ed25519` and `mnemonics`.

- `algonaut_encoding` implements encoding utility functions such as `serde` visitors.

- `algonaut_transaction` support developers in building all kinds of Algorand transactions.

- `algonaut_abi` Application Binary Interface (ABI) to invoke smart contract methods with a standarized interface.

## Running the examples

The `/examples` contains a wide set of examples that can help you getting started with `algonaut`. You can run them like this:

```bash

cargo run --example quickstart

```

If your environment variables are not properly set, you will read the message `Error: NotPresent`. If this is the case, just run:

```bash

cp examples.env .env

```

## External utilities

- [tealdbg_launcher](https://github.com/ivanschuetz/tealdbg_launcher) Start TEAL debugging sessions from Rust.

## Integration examples

- [React Js / WalletConnect / My Algo signing / WASM / atomic swaps](https://github.com/ivanschuetz/swaplink)

- [Basic React JS / WASM](https://github.com/ivanschuetz/algonaut-react)

- [My Algo signing with Yew / WASM](https://github.com/i-schuetz/algonaut-myalgo-yew-template)

- [Payment prompt with Yew / WASM](https://github.com/i-schuetz/algo-prompt)

- [Basic Yew / WASM](https://github.com/i-schuetz/algorand-yew-example)

- [iOS app](https://github.com/i-schuetz/algonaut_ios)

## Changelog

Read the [changelog](./CHANGELOG.md) for more details.

## Contribute

Do you want to help with the development? Please find out how by reading our [contributions guidelines](https://github.com/manuelmauro/algonaut/blob/main/CONTRIBUTING.md).

## Acknowledgements

This crate is based on the work of [@mraof](https://github.com/mraof/rust-algorand-sdk).

## License

[![Ferris Algonaut](assets/ferris-algonaut.svg)](https://crates.io/crates/algonaut)

Licensed under MIT license.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, shall be licensed as above, without any additional terms or conditions.

[Ferris Algonaut](assets/ferris-algonaut.svg) is licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).  

[Rust `algonaut`'s logo](assets/rocket-solid.svg) is based on [Font Awesome](https://fontawesome.com/v5.15/icons/rocket)'s icon and licensed under a [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).