Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: feegrant module for blobs submission via DA Light node #1500

Merged
merged 11 commits into from
Jun 26, 2024
4 changes: 4 additions & 0 deletions .vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -650,6 +650,10 @@ function sidebarHome() {
text: "Submitting data blobs to Celestia",
link: "/developers/submit-data",
},
{
text: "FeeGrant module for blobs submission",
link: "/developers/feegrant-for-blobs",
},
{
text: "Transaction resubmission guidelines",
link: "/developers/transaction-resubmission",
Expand Down
238 changes: 238 additions & 0 deletions developers/feegrant-for-blobs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,238 @@
# FeeGrant module for blobs submission
jcstein marked this conversation as resolved.
Show resolved Hide resolved

## Overview

This guide provides developers with the knowledge to use the FeeGrant
module on the Celestia's Mocha testnet chain for granting a data
availability node's account to submit blobs without constantly
funding it, enabling a third-party account to cover the transaction fees.
jcstein marked this conversation as resolved.
Show resolved Hide resolved

## Pre-requisites

- celestia-node binary (`celestia`) [installed](../nodes/celestia-node.md)
- Access to a Mocha node (e.g., `https://rpc.celestia-mocha.com:443`)
- Running DA Light node on Mocha testnet
- One account with sufficient funds, the "granter"
- One account with no funds, the "grantee"

## Introduction

Each DA node contains a Celestia account that is used to pay for blobs
submissions. To unify the fee payment process, the FeeGrant module
allows a third-party account (granter) to pay for the fees incurred by
a DA node's (grantee) account. You will need one account that will
contain the funds, the granter, and another account that will be in the
DA node you run to post blobs, the grantee. You will see the DA node's account
once you initialize the node. Learn more about managing accounts with
`cel-key` in [create a wallet with celestia-node](./celestia-node-key#create-a-wallet-with-celestia-node).

## Granting fee allowances using celestia-node

To get started granting the fee allowance, you will need
two separate keys to run the light node with. One to begin the
FeeGrant as the granter and another to use the FeeGrant as the grantee.

Set some variables for your accounts for the remainder of the guide:

```bash
export GRANTER_ADDRESS=<your-granter-account-address>
export GRANTEE_ADDRESS=<your-grantee-account-address>
export RPC_URL=rpc.celestia-mocha.com
```

### FeeGrant module implementation in celestia-node

Using celestia-node, you now can easily give permission for
other nodes to submit transactions on your behalf. It is also
possible to revoke the grant.

The node that receives the grant has to run a node with the
`--granter.address=$GRANTER_ADDRESS>` flag to use FeeGrant functionality.

The granter address will be stored until the next run of your local node.
So, in case the granter revokes permission, you will have to restart the
node without this flag.

::: tip
Transactions paid for by the the FeeGrant module will consume more gas than
regular `PayForBlobs` transactions.

| Fee and transaction type | Transaction 1 | Transaction 2 |
|--------------------------------|----------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| 0.000176 fee with feegrant on Mocha testnet | [Link](https://mocha.celenium.io/tx/82384c8006c6cf73072ffeb160f78c659447dba1757e4a4f6d5e6684935acc61) | [Link](https://mocha.celenium.io/tx/83fa70a496eaf4fa21da43c88c1f0bf8f9aa6676ec1d47f183fca948ab418f94) |
| 0.00016 fee without feegrant on Mocha testnet | [Link](https://mocha.celenium.io/tx/9e15dcf7e82288bdf0efc06edf92a30eead60d5ed6518a4721fee1bc34613e2c) | [Link](https://mocha.celenium.io/tx/a670112dee5bc2001b18225587f2cce86c97016a87d33cc1425b755518050348) |

:::

### Grant permission for an allowance as a granter

First, your node will need to be running with a command similar to:

```bash
celestia light start --p2p.network mocha --core.ip $RPC_URL \
--keyring.accname granter_key
```

Then, grant the fee to the grantee:

```bash
celestia state grant-fee $GRANTEE_ADDRESS 2000 1000000
```

Note that the `--amount uint` flag specifies the spend limit (in utia) for the
grantee. The default value is 0 which means the grantee does not have a spend
limit.

To set a limit of 42069 utia, use the following command:

```bash
celestia state grant-fee $GRANTEE_ADDRESS 2000 1000000 \
--amount 42069
```

Find the [example transaction on Celenium](https://mocha.celenium.io/tx/532c2d63b0732e335def1cb7f805bb798793fda43f88a955c5a9224dc6d0433e).

## Using a FeeGrant allowance as a grantee in celestia-node

First, start your node with the grantee account:

```bash
celestia light start --core.ip $RPC_URL --p2p.network=mocha
--granter.address=$GRANTER_ADDRESS
```

To check the balance of a light node, use the following command:

```bash
celestia state balance
```

Example response when the account balance does not exist:

```json
{
"result": {
"denom": "utia",
"amount": "0"
}
}
```

This indicates that the light node currently does not have any funds.

Now submit a blob:

```bash
celestia blob submit 0x42690c204d39600fddd3 0x6665656772616e74
```

You'll see the height and the commitment of your blob:

```json
{
"result": {
"height": 1639397,
"commitments": [
"19L/C4iBEsqXGzC5ZxJ3vtuGBiAdQAMIEnbYjKEGcac="
]
}
}
```

After the transactions made making this guide,
[see that the account balance is still 0 utia](https://mocha.celenium.io/address/celestia1e500l0nlwqj7x5vsqcxqd8rns5khvfw0skgu60).


## Checking account balances after submission

Light node account:
After submitting a blob, you can check the light node account's balance
to verify that the fees have been deducted:
<!-- markdownlint-disable MD013 -->
```bash
celestia state balance
```
<!-- markdownlint-enable MD013 -->

Example output showing fees are not deducted:

```json
{
"result": {
"denom": "utia",
"amount": "0"
}
}
```

## Optional: Revoke permission for a FeeGrant allowance as a granter

To revoke the feegrant, run your light node as the granter and run:

```bash
celestia state revoke-grant-fee $GRANTEE_ADDRESS 2000 1000000
```

There is also a specific error for the case when you run your node as a
grantee, but the granter revokes their permission. In this case, your transaction will
fail with the error: `granter has revoked the grant`
This will mean that you have to restart the node without the `granter.address`
flag.


### Optional: Submitting a blob from file input

To submit a blob from file input:
<!-- markdownlint-disable MD013 -->
```bash
celestia blob submit --input-file blob.json
```
<!-- markdownlint-enable MD013 -->

## Optional: Granting fee allowances using celestia-appd

To grant fee allowances, allowing a third-party (granter) account to pay
for the fees incurred by a Celestia data availability node (grantee)
account, use the following commands.

Set your account addresses for grantee and granter, and
the RPC URL:

```bash
export GRANTER_ADDRESS=<your-granter-account-address>
export GRANTEE_ADDRESS=<your-grantee-account-address>
export RPC_URL=https://rpc.celestia-mocha.com:443
```

Then, send the feegrant transaction:

<!-- markdownlint-disable MD013 -->
```bash
celestia-appd tx feegrant grant \
$GRANTER_ADDRESS $GRANTEE_ADDRESS \
--node $RPC_URL \
--spend-limit 1000000utia \
--allowed-messages "/cosmos.bank.v1beta1.MsgSend,/celestia.blob.v1.MsgPayForBlobs" \
--chain-id mocha-4 \
--keyring-backend test \
--fees 20000utia \
--broadcast-mode block \
--yes
```
<!-- markdownlint-enable MD013 -->

Example:
[FeeGrant transaction on Mocha](https://mocha.celenium.io/tx/802a17777fbeab416f6fa2c25f0c56dd9cc8a92afc2a96293d114ac7c22efb5c)

### Optional: Checking the granter's account

To confirm that the fees have been deducted from the granter's account that
granted the fee allowance, run:

```bash
celestia-appd query bank balances $GRANTER_ADDRESS \
--node https://rpc.celestia-mocha.com:443 --denom utia
```

This output will show the remaining balance after fees have been deducted,
confirming that the FeeGrant module is working as intended.
4 changes: 2 additions & 2 deletions nodes/celestia-app-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Example usage:

```sh
celestia-appd q bank balances celestia1czpgn3hdh9sodm06d5qk23xzgpq2uyc8ggdqgw \
--node https://rpc-mocha.pops.one
--node https://rpc-mocha.pops.one:443
```

Transfer tokens from one wallet to another:
Expand All @@ -137,7 +137,7 @@ Example usage:

```sh
celestia-appd tx bank send <FROM_ADDRESS> <TO_ADDRESS> \
19000000utia --node https://rpc-mocha.pops.one/ --chain-id mocha
19000000utia --node https://rpc-mocha.pops.one:443 --chain-id mocha
```

To see options:
Expand Down
Loading