Skip to content

Latest commit

 

History

History
192 lines (138 loc) · 7.15 KB

01-fsa-cli.mdx

File metadata and controls

192 lines (138 loc) · 7.15 KB
sidebar_position slug title authors description tags keywords unlisted
1
fsa-cli
Flare Smart Accounts CLI
nikerzetic
filipkoprivec
Introduction to the Flare Smart Accounts CLI.
intermediate
ethereum
flare-smart-accounts
flare-fdc
ethereum
flare-smart-accounts
evm
flare-network
account-abstraction
false

import ThemedImage from "@theme/ThemedImage"; import useBaseUrl from "@docusaurus/useBaseUrl";

The Flare Smart Accounts CLI is a tool written in Python that streamlines the Flare Smart Accounts process by properly structuring and sending XRPL transactions/instructions. It has commands corresponding to each Flare Smart Accounts action (table of instructions), as well as other useful debugging features.

:::note The CLI executes only the transaction on XRPL. It does not bridge the instructions to Flare. That is done by the operator - a service that Flare runs. :::

To use the CLI, first clone the repository and install the necessary dependencies:

git clone https://github.com/flare-foundation/smart-accounts-cli.git
cd smart-accounts-cli
pip install -r requirements.txt

Copy the .env.example file to the .env file, and fill in the missing values in the latter.

cp .env.example .env

The missing values are an XRPL testnet account secret value, a Flare address private key, and the RPC URLs for both Flare's Coston2 and XRPL testnet. You can create a new secret string through the XRP faucets.

You can then run the script with the command:

smart_accounts [-h] [--version] {bridge,debug} ...

bridge command

{/* TODO:(Nik) check if the second sentence is still true */} The bridge command executes an XRPL transaction with instructions for one of the actions, determined by the positional argument provided. A payment transaction with the appropriate memo field value is sent to the operator's XRPL address from the XRPL address specified in the .env file.

What follows is a list of possible positional arguments, what they do, and the additional parameters of each.

deposit

Deposit an amount of FXRP from the smart account belonging to the XRPL address to the Firelight vault, designated by the MasterAccountController contract.

./smart_accounts.py bridge deposit -a <amount>

withdraw

Begin the withdrawal process from the Firelight vault. An amount of FXRP is marked to be withdrawn from the Firelight vault to the user's smart account.

./smart_accounts.py bridge withdraw -a <amount>

redeem

Redeem a lots amount of FXRP. That number of lots of FXRP are burned from the user's smart account, and the same amount of XRP is sent to the user's address on XRPL.

./smart_accounts.py bridge redeem -l <lots>

mint

Mints a number of lots of FXRP to the user's smart account. The script first reserves collateral with the agent with the address (if you are unsure what agent to choose on coston2, use 0x55c815260cBE6c45Fe5bFe5FF32E3C7D746f14dC), by sending a reserveCollateral instruction. It then sends a lots amount of XRP to the agent's underlying address. An executor, determined by the MasterAccountController, will complete the minting process, and lots of FXRP will be minted to the user's smart account.

./smart_accounts.py bridge mint -a <address> -l <lots>

claim-withdraw

Complete the withdrawal process from the Firelight vault by claiming the funds. After the withdrawal process has been started, the funds are locked for a certain amount of time. Once that period has passed, they can be transferred back to the user's smart account.

./smart_accounts.py bridge claim-withdraw

custom

Execute a custom action on the Flare chain. Make a transaction to the address, paying the value, and attaching the calldata. The calldata is the encoding of a function and its argument values, on the smart contract at the `address.

./smart_accounts.py bridge custom -a <address> -v <value> -d <calldata>

Before making a transaction on XRPL with the necessary instructions, this command performs an additional step. It first packs the three provided values (address, value, and calldata) into a IMasterAccountController.CustomInstruction struct. Then, it calls the registerCustomInstruction function of the MasterAccountController contract, with the former as an argument.

Thus, it both registers a custom instruction with the MasterAccountController contract and retrieves the required callHash, which it can then send to the operator's XRPL address as instructions.

You can also use the command with json file containing an array of custom instructions. Two provided json files in json_examples/ directory demonstrate the expected format.

./smart_accounts.py bridge custom json_example/sendFXRPCoston.json

debug command

The debug command offers some utility options for running the CLI. It allows three positional arguments: mock-custom, check-status, and simulation.

mock-custom

Simulate a custom instruction with the mock MasterAccountController contract. Instead of sending the instructions as a transaction on XRPL and bridging them to Flare, the custom instructions are sent to the MasterAccountController contract directly. This is explained in more detail in the Custom instructions guide.

The address, value, and data parameters are the same as for the custom positional argument. The seed is a string representing an XRPL account.

./smart_accounts.py debug mock-custom -s <seed> -a <address> -v <value> -d <calldata>

As with the custom command, you can also use a json file containing an array of custom instructions.

./smart_accounts.py debug mock-custom -s <seed> json_example/sendFXRPCoston.json

check-status

Check the status of the XRPL transaction with the xrpl_hash.

./smart_accounts.py debug check-status <xrpl_hash>

simulation

{/* Run the simulation of the FAsset cycle. */} Run the simulation of the FAsset cycle. It converts mint lots of XRP to FXRP, deposits deposit FXRP into the Firelight vault, withdraws deposit FXRP back to the smart account, and finally redeems mint FXRP back to XRP.

./smart_accounts.py debug simulations -a <address> -m <mint> -d <deposit>

This is equivalent to running the following commands:

./smart_accounts.py bridge mint -a <address> -l <mint>
./smart_accounts.py bridge deposit -a <deposit>
./smart_accounts.py bridge withdraw -a <deposit>
./smart_accounts.py bridge claim-withdraw
./smart_accounts.py bridge redeem -l <mint>

encode command

The encode command prints encoded memo fields that can be used in XRPL transactions to instruct the operator to perform certain actions on Flare.

./smart_accounts.py encode custom json_example/requestRedemption.json
./smart_accounts.py encode mint -l 1