πŸ“šLST Creator API

No React? No Worriesβ€”Mint LSTs Directly with The Vault API.

πŸ“Œ Introduction

For developers who prefer not to use React or wish to integrate minting functionality in a custom manner, The Vault offers a direct API endpoint at https://direct.thevault.finance/. This API enables you to mint Liquid Staking Tokens (LSTs) by constructing transactions tailored to your application's requirements.

πŸ”— GitHub Repository: The Vault LST Creator Widget

πŸ”— API Endpoint

  • URL: https://direct.thevault.finance/

⚑ Required Query Parameters

To successfully create a transaction, the following parameters must be included in the request:

Parameter
Type
Description

mint

String

The mint address of the LST to be minted.

wallet_address

String

The wallet address initiating the minting process.

amount

Number

The amount of tokens to be minted.

current_balance

Number

The current balance of the user's wallet.

βš™οΈ Optional Parameter

  • target (String): Required only when minting vSOL, specifying the target address.

πŸ“Š API Response

Upon sending a valid request, the API returns a base64-encoded transaction (transaction). The user's wallet must sign this transaction and then broadcast it to the Solana network to complete the minting process.

πŸš€ Integration Steps

1️⃣ Construct the API Request

Gather the required parameters (mint, wallet_address, amount, current_balance). If minting vSOL, also include the target parameter.

2️⃣ Send the Request

Make a GET request to:

https://direct.thevault.finance/

with the collected parameters.

3️⃣ Handle the Response

Receive a base64-encoded transaction (transaction) from the API.

4️⃣ Sign the Transaction

Prompt the user's wallet to sign the received transaction.

5️⃣ Broadcast the Transaction

Submit the signed transaction to the Solana network for processing.

πŸ’‘ Example API Call

You can test the API with the following example:

curl "https://direct.thevault.finance/stake?\
address=<Minter's wallet address>&\
mint=gridBR1TSJcV1JjAEE9g7ouoiVaEgDNT3dhY6n9oKQq&\
amount=100000&\
balance=1000000"

If you run this, you will receive a transaction (transaction) that you can inspect and simulate by pasting it into the Solana Transaction Inspector.

πŸ“ž Need Help?

For any issues or questions, join our Discord community.

Get started today and integrate LST minting seamlessly into your application!

Last updated