DEV Community: Peter

Soroban Snippets: Basic of Building Dapp Part 2

Peter — Wed, 13 Dec 2023 09:34:09 +0000

Validating Stellar/Soroban Information

In this section, we will explore straightforward validation methods available in the Soroban SDK, specifically designed to authenticate and validate public keys, secret keys, and contract IDs. These methods serve as essential tools to ensure the authenticity and validity of inputs in various contexts within your decentralized application (dApp). Whether validating a public key for an Address or confirming its suitability for a xdr.ScVal object, these techniques establish a robust foundation for data integrity, empowering your dApp with reliable and secure information handling.

Validating Stellar/Soroban Information

Emitting and Retrieving Events

The provided React component appears to be a part of a larger project that involves emitting and retrieving events using Soroban on the Stellar network. The code snippet focuses on showcasing the process of emitting events in the Soroban smart contract. The increment method within the contract increments a counter, saves the updated count to the storage, and publishes an event with relevant details, including the count. The accompanying code demonstrates how to use the stellar-sdk library and the RPC API for interacting with the Soroban testnet. Additionally, the component includes a sample event query, allowing users to try out the code and retrieve contract events. The UI provides buttons for executing specific actions, such as getting events or triggering an increment event, and a console log for displaying the output. This component serves as a valuable resource for developers seeking hands-on experience with Soroban events on the Stellar network.
Emitting and Retrieving Events

Migration between `soroban-client` to `stellar-sdk`

Within the realm of dapp development, two libraries are actively maintained—soroban-client and stellar-sdk. The primary emphasis in this context is streamlining the migration process from soroban-client to stellar-sdk for Soroban application development. The introductory section highlights the coexistence of these two JavaScript libraries and recommends opting for the more actively maintained stellar-sdk when constructing a Soroban/Stellar application. This superior library not only mirrors all the features of soroban-client but also integrates its implementation. The migration process between the two is straightforward, and the subsequent guide furnishes illustrative examples for transitioning key features, specifically focusing on Server, SorobanRpc, and AssembleTransaction functionalities.

Migration between soroban-client to stellar-sdk

Soroban PRNG

In Preview 11, Soroban has implemented a Pseudo Random Generator (PRNG) in their smart contract SDK in Rust. This segment will take a look at Soroban Rust PRNG library, particularly relevant for Stellar smart contract development and adaptable for dapps seeking a reliable pseudorandom number generation (PRNG) solution. The library facilitates on-chain randomness and includes techniques for vector shuffling and generating random numbers within defined intervals. While it assures simplicity and reliability in generating randomness within the Stellar ecosystem, it's essential to note its unsuitability for security-sensitive applications or those with low risk tolerance. Further details and usage guidelines can be explored in the comprehensive documentation. The provided Rust code snippets offer practical demonstrations of these functionalities. Users can interactively experience the PRNG capabilities, such as rolling a dice and shuffling a provided list, through the demonstrated usage sections and associated buttons.

Soroban PRNG

Generating and Deriving Stellar Accounts with Seed Phrases

Stellar incorporates a key derivation protocol known as SEP-0005. This protocol plays a crucial role in enhancing key storage, fostering interoperability across wallets, supporting hardware wallets, and facilitating mnemonic code-based cold storage. The demonstration will leverage Bitcoin's BIP-0039 standard to generate a 12-word or 24-word seed phrase, serving as a standard for SEP-0005. The protocol utilizes the m/44'/148'/0' as the primary key. The article not only explores Stellar Ecosystem Proposal SEP-0005 but also demonstrates how to generate word phrases for a Stellar account and derive them into Soroban's KeyPair for transaction use. This comprehensive overview equips developers with the knowledge and tools necessary for secure key management within the Stellar network, serving as a valuable guide for creating and integrating Stellar Wallets.

Generating and Deriving Stellar Accounts with Seed Phrases

Soroban Snippets: Understanding Assets with Smart Contracts

Peter — Mon, 04 Dec 2023 23:48:15 +0000

1. Create Stellar Asset

Assets play a fundamental role in Stellar, representing tokens, liquidity pools, or even NFTs that can be both created and transferred. Identification of Stellar Assets is based on an Asset Code and the issuer's public key. Creating a Stellar Asset is a straightforward process with numerous tutorials available, such as the one provided by the Stellar Development Foundation (SDF) titled Issue an Asset. In essence, the creation involves two public keys, namely an issuer and a distributor. The procedure includes establishing a trustline before transferring funds and assets to the destination address through a payment operation. The tutorial further introduces the crucial concept of unique asset identification, underscoring the significance of combining asset codes and issuer public keys. By following this guide, you can enhance your comprehension and gain hands-on experience in the creation and management of assets on the Stellar network.

Create Stellar Asset

2. Create Soroban Wrapped Asset

Soroban, a smart contract platform for Stellar, introduces a unique asset management approach by enabling the creation and funding of Stellar Assets that can be wrapped into Soroban tokens. This process incorporates smart contracts, representing wrapped assets similarly to Classic Assets. Additionally, Soroban supports the issuance of tokens as Stellar Assets or as custom Soroban Tokens, providing flexibility in logic implementation. The "Stellar Asset Contract" (SAC) (Like the ERC-20), further enhances interoperability by allowing users to utilize their (classic) Stellar account and trustline balances in Soroban. The soroban lab token wrap command facilitates experimentation with wrapping. However in this comprehensive tutorial guides users incoporate the wrapping functionality in their dapps (JS/TS) through HostFunction creation, Operation generation, and the use of Freighter to wrap assets and integrate them into the wallet.

Create Soroban Wrapped Asset

3. Get Contract from Wrapped Asset

Once a token is created and wrapped, understanding how to retrieve its information becomes crucial. There are scenarios where assessing the token contract becomes necessary to invoke its methods. This section elaborates on the process of transforming Stellar Assets into Soroban contracts, offering insights into two distinct methods for this conversion. The resulting contract ID, beginning with "C," represents a hashed version of the asset's details. It's important to note that these contract IDs are hypothetical and may not exist if the asset is not wrapped or created. In the tutorials, developers have the opportunity to input the asset code and issuer details, exploring and comprehending the process of obtaining Soroban contracts from Wrapped Stellar Assets.

Get Contract from Wrapped Asset

Soroban Snippets: Guide to Soroban Smart Contracts for Web3 DApps

Peter — Fri, 01 Dec 2023 05:00:00 +0000

1. Installing Contract/WASM to Soroban

One of the first things to do when needing to deploy a Soroban contract is to deploy its .wasm file on the Soroban blockchain. The following tutorial guides developers through essential steps for ensuring their smart contracts are deployment-ready on Soroban. Notably, it distinguishes between installing and deploying a smart contract, shedding light on the former. The document introduces the use soroban-client tool and delves into the critical role of hostFunctionTypeUploadContractWasm in JavaScript. Practical usage is demonstrated through code snippets, explaining the interaction with the Soroban blockchain, transaction building, and signing process with Freighter. Overall, it stands as a valuable resource for developers navigating the intricacies of smart contract installation on the Soroban blockchain in a web environment.

Installing Contract/WASM to Soroban

2. Soroban Contract Deployment

Having successfully deployed a contract WASM on Soroban, the next step involves creating a contract instance. This tutorial explores the deployment process, emphasizing the utilization of the soroban-client js library to contract deployment on Soroban. It focuses on key elements such as the creation of a contract ID preimage and the construction of contract arguments. The guides will help web3 developers through the process of building a host function transaction. To enhance practical understanding there is also a working demo allowing users to interactively deploy a Soroban token, equipping developers with the knowledge and tools required for proficient Soroban smart contract deployment in JavaScript and TypeScript.

Soroban Contract Deployment

3. Execute Soroban Smart Contract

There are several approaches to invoking methods of a Soroban contract, and this demonstration introduces the capabilities of the Contract class in the soroban-client library. With interactive examples, it provides insights into seamless communication with smart contracts. Similar to the token contract discussed in Part 2, we'll implement a TypeScript code snippet that demonstrates the invocation process and transaction building using the contract.call() method for Soroban. This guide aims to showcase the practical application of the Contract class, enabling developers to effectively interact with and execute transactions on Soroban smart contracts.

Execute Soroban Smart Contract

4. Retrieve WebAssembly (WASM) Code from Smart Contract

You can do many things in your web application with the soroban-client. One of which is retrieving the WebAssembly (Wasm) code from a Soroban contract. Beyond gaining insights into the contract, its modules, and imports/exports, developers can leverage this feature for deploying an identical contract to Soroban without the need for recompilation or for inspecting the contract code. The contractData and contractCode steps outline a streamlined two-step procedure for obtaining the Wasm file associated with a Soroban smart contract. This entails querying the Soroban blockchain to retrieve the Wasm ID and subsequently using that ID to fetch the corresponding Wasm file. Soroban Snippet introduces a comprehensive function, elucidated in the code below, that facilitates the retrieval of the Wasm file from the blockchain as a downloadable file, providing developers with a powerful tool for a deeper understanding of Soroban contract intricacies.

Retrieve WebAssembly (WASM) Code from Smart Contract

5. Access Soroban Contract Storage State

In addition, Soroban has many storage types to avoid storage bloats and manage efficiency data on the chain. The provided tutorial will focus on the storage state and information of a Soroban smart contract, this guide sheds light on the key-value pairs stored within the contract. Specifically, it delves into the Instance storage, accessible through the Env.storage().instance() code in your Dapps. Subsequently, we again introduce again to contractData in the soroban-client JS library. This step involves constructing a LedgerKey for contract data, fetching ledger entries from the Soroban server, and extracting relevant information, such as instance storage. Of course, every tutorial will provide a snippet and runnable example to see what you can expect when using these methods.

Access Soroban Contract Storage State

6. Construct Soroban Contract ABI in JavaScript/TypeScript

If you ever find yourself needing to explore a Soroban contract's methods along with their inputs and outputs, the Soroban CLI comes with its inspect command. This command, when provided with the WebAssembly (Wasm) code, returns a detailed list of contract specifications. These specifications include functions, as well as custom data types like enums and structs, associated with the Rust code. However, when working on a web app, integrating this process might pose some challenges. Therefore, this tutorial endeavours to establish an approach for obtaining comprehensive insights into a Soroban contract that goes beyond just its Wasm code. The goal is to create a method that emulates the functionality of the inspect command. It's worth noting that this involves utilizing the WebAssembly.Module inherent to JavaScript and the Soroban convention for storing information in the contractspecv0 section.

Construct Soroban Contract ABI in JavaScript/TypeScript

7. Restore Expired Contract/WASM

As far as Testnet and Futurenet in Soroban, contract data have a lifetime. In order to maintain and use a smart contract on Soroban, there data and wasm on the network must be maintained. The process involves retrieving expiration details and utilizing the Operation.restoreFootprint() method to obtain ledger keys associated with the contract instance.

Restore Expired Contract/WASM

Soroban Snippets: Basic of Building Dapp

Peter — Thu, 23 Nov 2023 21:47:17 +0000

Welcome to the series of many where we'll be going over building in Soroban. Soroban Snippet is an application aimed to empower developers by providing comprehensive educational and interactive examples of working and building within the Stellar Network. We strive to simplify web and Dapp development on Soroban, offering practical insights and hands-on snippets in each section. Whether you're navigating the intricacies of network connections, estimating gas costs, or submitting transactions, our goal is to equip you with the knowledge and practical snippets that seamlessly integrate into your Soroban applications.

Soroban Snippet

1. Setting soroban and Freighter in JavaScript/TypeScript

The first thing we need to do is set up our connections to Soroban. In order to do so, we need the network information such as Passphrase and RPC. soroban-client makes it easy to connect to futurenet or testnet with the Server. This guide will provide you with the necessary information to connect to all Soroban networks, and let you test out whether a connection is successful.

Setting soroban and Freighter in JS/TS

2. Getting Gas Estimation in Soroban

Gas plays a pivotal role in blockchain transactions. In the context of Soroban and Stellar's smart contracts, invoking contracts or adding operations incurs a fee, commonly referred to as gas. This tutorial introduces an uncomplicated yet powerful method for estimating transaction fees by leveraging the simulateTransaction method. A trial run tailored for contract invocations. Developers can utilize this approach to assess gas costs comprehensively before executing methods on Soroban smart contracts, providing them with essential insights into optimizing transaction economics. The tutorial further exemplifies this technique through a practical demonstration, estimating the gas cost for invoking the "mint" method on a Soroban smart token written in Rust, thereby offering developers a practical tool to refine their gas cost considerations before actual transaction execution.

Getting Gas Estimation in Soroban

3. Practical Guide Custom Types to XDR in JavaScript/TypeScript

In this following tutorial, we'll go through an interactive guide on structuring custom types for Soroban smart contracts. This includes practical implementation of Rust enum and struct into Soroban's ScVal type. The Enum section illustrates the conversion of a Rust Enum, such as TimeBoundKind, into its JavaScript/TypeScript counterpart using scvVec and scvSymbol. Similarly, the Struct section demonstrates the transformation of a Rust Struct, like TimeBound, and an unnamed struct into Soroban's ScVal using scvMap and scvVec. Developers can utilize these practical examples to seamlessly incorporate complex custom types into Soroban smart contract calls, enhancing the flexibility and functionality of their applications.

Practical Guide Custom Types to XDR in JavaScript/TypeScript

4. Submit Transaction Process

When building a Blockchain Dapp, developers frequently encounter the task of submitting transactions to the network. In the context of using soroban-client, this involves dispatching a transaction to the server. It's crucial to note that the Soroban client doesn't wait for transaction completion. Instead, a socket-like approach is necessary to continuously read the transaction status until it reaches completion. Developers can then handle the response based on its status. The provided demonstration delves into the fundamentals of these responses, with a specific focus on the SorobanRpc.GetTransactionResponse. It illustrates how developers can extract relevant information from transactions within practical usage scenarios.

Submit Transaction Process

5. Difference Transaction and Transaction Envelope

In Stellar, Transactions hold operations that modify the ledger, while the concept of a Transaction Envelope comes into play when a transaction is readied for signing. Essentially, it is a transaction that encompasses not only the transaction itself but also integrates a set of signatures. Diverging from raw Transaction objects, transaction envelopes circulate throughout the network and constitute essential elements of transaction sets. This differentiation elucidates their role in the Stellar ecosystem, offering a layered approach to transaction handling. Additionally, the demo provides an illustration of unwrapping XDR into its respective transaction and Transaction Envelope, facilitating their utilization with soroban-client to submit to the network.

Difference Transaction and Transaction Envelope

DEV Community: Peter

Soroban Snippets: Basic of Building Dapp Part 2

Validating Stellar/Soroban Information

Emitting and Retrieving Events

Migration between soroban-client to stellar-sdk

Soroban PRNG

Generating and Deriving Stellar Accounts with Seed Phrases

Soroban Snippets: Understanding Assets with Smart Contracts

1. Create Stellar Asset

2. Create Soroban Wrapped Asset

3. Get Contract from Wrapped Asset

Soroban Snippets: Guide to Soroban Smart Contracts for Web3 DApps

1. Installing Contract/WASM to Soroban

2. Soroban Contract Deployment

3. Execute Soroban Smart Contract

4. Retrieve WebAssembly (WASM) Code from Smart Contract

5. Access Soroban Contract Storage State

6. Construct Soroban Contract ABI in JavaScript/TypeScript

7. Restore Expired Contract/WASM

Soroban Snippets: Basic of Building Dapp

1. Setting soroban and Freighter in JavaScript/TypeScript

Migration between `soroban-client` to `stellar-sdk`