Skip to main content
Glama

Algorand MCP

by GoPlausible
developer:docs:sdks:javascript:index.md8.82 kB
title: JS SDK: Your First Transaction This section is a quick start guide for interacting with the Algorand network using JavaScript. This guide will help to install the [Algorand sandbox](https://github.com/algorand/sandbox){target=blank}, which provides a node for testing and development. This guide will also help to install the JavaScript SDK, create an account and submit your first transaction using different JavaScript Runtimes. ​ # Install Sandbox !!! info This step is only required if you are not using AlgoKit. If you are using AlgoKit, you can spin up a sandbox using the LocalNet, see [AlgoKit getting started guide](/docs/get-started/algokit/#start-a-localnet) for more information. !!! Prerequisites - Docker Compose ([install guide](https://docs.docker.com/compose/install/)) - Git ([install guide](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)) Algorand provides a docker instance for setting up a node, which can be used to get started developing quickly. To install and use this instance, follow these instructions. ​ ```bash git clone https://github.com/algorand/sandbox.git cd sandbox ./sandbox up dev ``` This will install and start private network. To read more about Algorand networks see [Algorand Networks](../../get-details/algorand-networks/index.md){target=_blank}. [More Information about the sandbox](https://developer.algorand.org/articles/introducing-sandbox-20/) and [how to use](https://developer.algorand.org/tutorials/exploring-the-algorand-sandbox/) it. ​ ​ # Install JavaScript SDK Algorand provides an [SDK for JavaScript](https://github.com/algorand/js-algorand-sdk). The instructions for installing the SDK will depend on what runtime you plan on using. !!! Prerequisites - Install [Node.js](https://nodejs.org/download) ​ ```bash # initialize project npm init # install Algorand sdk npm install algosdk # list the version npm list algosdk # This package provides TypeScript types, but you will need TypeScript version 4.2 or higher to use them properly. ``` The [GitHub repository](https://github.com/algorand/js-algorand-sdk){target=_blank} contains additional documentation and examples. See the JavaScript SDK [reference documentation](https://algorand.github.io/js-algorand-sdk/){target=_blank} for more information on methods. The SDK is installed and can now interact with the running Algorand Sandbox environment, as configured above. !!! Info Using a Web Runtime requires the AlgoSigner extension or other web-based private key management software. For more information see [community wallets](https://developer.algorand.org/docs/community/#wallets). ​ # Create an Account In order to interact with the Algorand blockchain, you must have a funded account. To quickly create a test account use the following code. <!-- ===JSSDK_ACCOUNT_GENERATE=== --> ```javascript const generatedAccount = algosdk.generateAccount(); const passphrase = algosdk.secretKeyToMnemonic(generatedAccount.sk); console.log(`My address: ${generatedAccount.addr}`); console.log(`My passphrase: ${passphrase}`); ``` [Snippet Source](https://github.com/algorand/js-algorand-sdk/blob/examples/examples/accounts.ts#L80-L84) <!-- ===JSSDK_ACCOUNT_GENERATE=== --> [`More Information`](../../get-details/accounts/create.md#standalone){target=_blank} !!! Warning Never share mnemonic private keys. Production environments require stringent private key management. For more information on key management in community wallets, click [here](https://developer.algorand.org/docs/community/#wallets). For the [Algorand open source wallet](https://developer.algorand.org/articles/algorand-wallet-now-open-source/), click [here](https://github.com/algorand/algorand-wallet). ​ # Fund the Account Before sending transactions to the Algorand network, the account must be funded to cover the minimal transaction fees that exist on Algorand. In this example, we'll be using prefunded accounts available in the Sandbox. To fund an account on Testnet account use the [Algorand faucet](https://dispenser.testnet.aws.algodev.network/){target=_blank}. ​ !!! Info All Algorand accounts require a minimum balance to be registered in the ledger. To read more about Algorand minimum balance see [Account Overview](https://developer.algorand.org/docs/features/accounts/#minimum-balance) ​ # Connect Your Client An Algod client must be instantiated prior to making calls to the API endpoints. You must provide values for `<algod-address>` and `<algod-token>`. The CLI tools implement the client natively. By default, the `algodToken` for each [sandbox](https://github.com/algorand/sandbox) is set to its `aaa...` value and the `algodAddress` corresponds to `http://localhost:4001`. <!-- ===JSSDK_ALGOD_CREATE_CLIENT=== --> ```javascript const algodToken = 'a'.repeat(64); const algodServer = 'http://localhost'; const algodPort = 4001; const algodClient = new algosdk.Algodv2(algodToken, algodServer, algodPort); ``` [Snippet Source](https://github.com/algorand/js-algorand-sdk/blob/examples/examples/overview.ts#L7-L12) <!-- ===JSSDK_ALGOD_CREATE_CLIENT=== --> !!! Info The example code connects to the sandbox Algod client. If you want to connect to a public API client, change the host, port, and token parameters to match the API service. See some service available [here](https://developer.algorand.org/ecosystem-projects/?tags=api-services) !!! Info If you are connecting to the Testnet, a dispenser is available [here](https://dispenser.testnet.aws.algodev.network/){target=_blank} # Check Your Balance Before moving on to the next step, make sure your account has been funded by the faucet. <!-- ===JSSDK_ALGOD_FETCH_ACCOUNT_INFO=== --> ```javascript const acctInfo = await algodClient.accountInformation(acct.addr).do(); console.log(`Account balance: ${acctInfo.amount} microAlgos`); ``` [Snippet Source](https://github.com/algorand/js-algorand-sdk/blob/examples/examples/overview.ts#L46-L48) <!-- ===JSSDK_ALGOD_FETCH_ACCOUNT_INFO=== --> # Build First Transaction Transactions are used to interact with the Algorand network. To create a payment transaction use the following code. <!-- ===JSSDK_TRANSACTION_PAYMENT_CREATE=== --> ```javascript const suggestedParams = await algodClient.getTransactionParams().do(); const ptxn = algosdk.makePaymentTxnWithSuggestedParamsFromObject({ from: acct.addr, suggestedParams, to: acct2.addr, amount: 10000, note: new Uint8Array(Buffer.from('hello world')), }); ``` [Snippet Source](https://github.com/algorand/js-algorand-sdk/blob/examples/examples/overview.ts#L23-L31) <!-- ===JSSDK_TRANSACTION_PAYMENT_CREATE=== --> !!! Info Algorand supports many transaction types. To see what types are supported see [Transactions](https://developer.algorand.org/docs/get-details/transactions/). ​ # Sign First Transaction Before the transaction is considered valid, it must be signed by a private key. Use the following code to sign the transaction. ​ <!-- ===JSSDK_TRANSACTION_PAYMENT_SIGN=== --> ```javascript const signedTxn = ptxn.signTxn(acct.privateKey); ``` [Snippet Source](https://github.com/algorand/js-algorand-sdk/blob/examples/examples/overview.ts#L34-L35) <!-- ===JSSDK_TRANSACTION_PAYMENT_SIGN=== --> !!! Info Algorand provides many ways to sign transactions. To see other ways see [Authorization](https://developer.algorand.org/docs/features/transactions/signatures/#single-signatures). # Submit the Transaction The signed transaction can now be submitted to the network.`waitForConfirmation` is called after the transaction is submitted to wait until the transaction is broadcast to the Algorand blockchain and is confirmed. The below snippet also shows how you can decode the data in the node field again to make it readable. <!-- ===JSSDK_TRANSACTION_PAYMENT_SUBMIT=== --> ```javascript const { txId } = await algodClient.sendRawTransaction(signedTxn).do(); const result = await algosdk.waitForConfirmation(algodClient, txId, 4); console.log(result); console.log(`Transaction Information: ${result.txn}`); console.log(`Decoded Note: ${Buffer.from(result.txn.txn.note).toString()}`); ``` [Snippet Source](https://github.com/algorand/js-algorand-sdk/blob/examples/examples/overview.ts#L38-L43) <!-- ===JSSDK_TRANSACTION_PAYMENT_SUBMIT=== --> ​ # View the Transaction To view the transaction we submitted to the sandbox Algod, open [Lora](https://lora.algokit.io/localnet){target=_blank} and choose `LocalNet` configuration option, then search for the transaction ID. To view a transaction submitted to public network like testnet, open [Lora](https://lora.algokit.io/testnet){target=_blank} or [Pera Explorer](https://testnet.explorer.perawallet.app/){target=blank} and paste the transaction ID into the search bar.

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/GoPlausible/algorand-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server