liquid

x/liquid

Abstract

This module enables the Cosmos Hub to support the issuance of native liquid staking denoms.

Contents

• State
  • TotalLiquidStakedTokens
  • PendingTokenizeShareAuthorizations
• Messages
  • MsgUpdateParams
  • MsgTokenizeShares
  • MsgRedeemTokensForShares
  • MsgTransferTokenizeShareRecord
  • MsgEnableTokenizeShares
  • MsgDisableTokenizeShares
  • MsgWithdrawTokenizeShareRecordReward
  • MsgWithdrawAllTokenizeShareRecordReward
• Begin-Block
  • Expire Tokenize Share Locks
• Events
  • EndBlocker
  • Msg's
• Parameters
• Client
  • CLI
  • gRPC
  • REST

State

Params

The liquid module stores its params in state with the prefix of 0x51, it can be updated with governance or the address with authority.

• Params: 0x51 | ProtocolBuffer(Params)

// Params defines the parameters for the x/liquid module.
message Params {
  option (amino.name) = "gaia/x/liquid/Params";
  option (gogoproto.equal) = true;

  // global_liquid_staking_cap represents a cap on the portion of stake that
  // comes from liquid staking providers
  string global_liquid_staking_cap = 8 [
    (gogoproto.moretags) = "yaml:\"global_liquid_staking_cap\"",
    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
    (gogoproto.nullable) = false,
    (amino.dont_omitempty) = true,
    (cosmos_proto.scalar) = "cosmos.Dec"
  ];
  // validator_liquid_staking_cap represents a cap on the portion of stake that
  // comes from liquid staking providers for a specific validator
  string validator_liquid_staking_cap = 9 [
    (gogoproto.moretags) = "yaml:\"validator_liquid_staking_cap\"",
    (gogoproto.customtype) = "cosmossdk.io/math.LegacyDec",
    (gogoproto.nullable) = false,
    (amino.dont_omitempty) = true,
    (cosmos_proto.scalar) = "cosmos.Dec"
  ];
}

TotalLiquidStakedTokens

TotalLiquidStakedTokens stores the total liquid staked tokens monitoring the progress towards the GlobalLiquidStakingCap.

• TotalLiquidStakedTokens: 0x5 -> math.Int.

PendingTokenizeShareAuthorizations

PendingTokenizeShareAuthorizations stores a queue of addresses that have their tokenize share re-enablement/unlocking in progress. When an address is enqueued, it will sit for 1 unbonding period before the tokenize share lock is removed.

// PendingTokenizeShareAuthorizations stores a list of addresses that have their
// tokenize share enablement in progress
message PendingTokenizeShareAuthorizations { repeated string addresses = 1; }

Messages

In this section we describe the processing of the liquid messages and the corresponding updates to the state. All created/modified state objects specified by each message are defined within the state section.

MsgTokenizeShares

The MsgTokenizeShares message allows users to tokenize their delegated tokens. Created denoms combine the validator address and record id of the underlying delegation, i.e. the denom of a created token would look like the following: {validatorAddress}/{recordId}.

// MsgTokenizeShares tokenizes a delegation
message MsgTokenizeShares {
  option (cosmos.msg.v1.signer) = "delegator_address";
  option (amino.name) = "gaia/MsgTokenizeShares";

  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  string delegator_address = 1
  [ (gogoproto.moretags) = "yaml:\"delegator_address\"" ];
  string validator_address = 2
  [ (gogoproto.moretags) = "yaml:\"validator_address\"" ];
  cosmos.base.v1beta1.Coin amount = 3 [ (gogoproto.nullable) = false ];
  string tokenized_share_owner = 4;
}

This message returns a response containing the number of tokens generated:

// MsgTokenizeSharesResponse defines the Msg/MsgTokenizeShares response type.
message MsgTokenizeSharesResponse {
  cosmos.base.v1beta1.Coin amount = 1 [ (gogoproto.nullable) = false ];
}

This message is expected to fail if:

• The delegator sender's address has disabled tokenization, meaning that the account lock status is either LOCKED or LOCK_EXPIRING.
• The account is a vesting account and the free delegation (non-vesting delegation) is exceeding the tokenized share amount.
• The tokenized shares exceeds either the GlobalLiquidStakingCap, the ValidatorLiquidStakingCap.

When this message is processed the following actions occur:

• Increment the GlobalLiquidStakingCap
• Increment the validator's ValidatorLiquidStakingCap
• Unbond the delegation shares and transfer the coins back to delegator
• Create an equivalent amount of tokenized shares that the initial delegation shares
• Mint the liquid coins and send them to delegator
• Create a tokenized share record
• Get validator to whom the sender delegated his shares
• Send coins to module address and delegate them to the validator

MsgRedeemTokensForShares

The MsgRedeemTokensForShares message allows users to redeem their native delegations from share tokens.

// MsgRedeemTokensForShares redeems a tokenized share back into a native
// delegation
message MsgRedeemTokensForShares {
  option (cosmos.msg.v1.signer) = "delegator_address";
  option (amino.name) = "gaia/MsgRedeemTokensForShares";

  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  string delegator_address = 1
  [ (gogoproto.moretags) = "yaml:\"delegator_address\"" ];
  cosmos.base.v1beta1.Coin amount = 2 [ (gogoproto.nullable) = false ];
}

This message returns a response containing the amount of staked tokens redeemed:

// MsgRedeemTokensForSharesResponse defines the Msg/MsgRedeemTokensForShares
// response type.
message MsgRedeemTokensForSharesResponse {
  cosmos.base.v1beta1.Coin amount = 1 [ (gogoproto.nullable) = false ];
}

This message is expected to fail if:

• If the sender's balance doesn't have enough liquid tokens

When this message is processed the following actions occur:

• Get the tokenized shares record
• Get the validator that issued the tokenized shares from the record
• Unbond the delegation associated with the tokenized shares
• Decrease the ValidatorLiquidStakingCap
• Decrease the validator's LiquidShares
• Burn the liquid coins equivalent of the tokenized shares
• Delete the tokenized shares record
• Send equivalent amount of tokens to the delegator
• Delegate sender's tokens to the validator

MsgTransferTokenizeShareRecord

The MsgTransferTokenizeShareRecord message enables users to transfer the ownership of rewards generated from the tokenized amount of delegation.

// MsgTransferTokenizeShareRecord transfer a tokenize share record
message MsgTransferTokenizeShareRecord {
  option (cosmos.msg.v1.signer) = "sender";
  option (amino.name) = "gaia/MsgTransferTokenizeShareRecord";

  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  uint64 tokenize_share_record_id = 1;
  string sender = 2;
  string new_owner = 3;
}

This message is expected to fail if:

• The tokenized shares record doesn't exist
• The sender address doesn't match the owner address in the record

When this message is processed the following actions occur:

• The tokenized shares record is updated with the new owner address

MsgEnableTokenizeShares

The MsgEnableTokenizeShares message begins the countdown after which tokenizing shares by the sender delegator address is re-allowed, which will complete after the unbonding period.

// MsgEnableTokenizeShares re-enables tokenization of shares for a given address
message MsgEnableTokenizeShares {
  option (cosmos.msg.v1.signer) = "delegator_address";
  option (amino.name) = "gaia/MsgEnableTokenizeShares";

  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  string delegator_address = 1
  [ (gogoproto.moretags) = "yaml:\"delegator_address\"" ];
}

This message returns a response containing the time at which the lock is completely removed:

// MsgEnableTokenizeSharesResponse defines the Msg/EnableTokenizeShares response
// type.
message MsgEnableTokenizeSharesResponse {
  google.protobuf.Timestamp completion_time = 1
      [ (gogoproto.nullable) = false, (gogoproto.stdtime) = true ];
}

This message is expected to fail if:

• If the sender's account lock status is either equal to UNLOCKED or LOCK_EXPIRING, meaning that the tokenized shares aren't currently disabled.

When this message is processed the following actions occur:

• Queue the unlock authorization.

MsgDisableTokenizeShares

The MsgDisableTokenizeShares message prevents the sender delegator address from tokenizing any of its delegations.

// MsgDisableTokenizeShares prevents the tokenization of shares for a given
// address
message MsgDisableTokenizeShares {
  option (cosmos.msg.v1.signer) = "delegator_address";
  option (amino.name) = "gaia/MsgDisableTokenizeShares";

  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  string delegator_address = 1
  [ (gogoproto.moretags) = "yaml:\"delegator_address\"" ];
}

This message is expected to fail if:

• The sender's account already has the LOCKED lock status

When this message is processed the following actions occur:

• If the sender's account lock status is equal to LOCK_EXPIRING, it cancels the pending unlock authorizations by removing them from the queue.
• Create a new tokenization lock for the sender's account. Note that if there is a lock expiration in progress, it is overridden.

MsgUpdateParams

The MsgUpdateParams updates the liquid module parameters. The params are updated through a governance proposal where the signer is the gov module account address.

// MsgUpdateParams is the Msg/UpdateParams request type.
message MsgUpdateParams {
  option (cosmos.msg.v1.signer) = "authority";
  option (amino.name) = "gaia/liquid/MsgUpdateParams";

  // authority is the address that controls the module (defaults to x/gov unless
  // overwritten).
  string authority = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
  // params defines the x/liquid parameters to update.
  //
  // NOTE: All parameters must be supplied.
  Params params = 2
      [ (gogoproto.nullable) = false, (amino.dont_omitempty) = true ];
};

The message handling can fail if:

• Signer is not the authority defined in the liquid keeper (usually the gov module account).

MsgWithdrawTokenizeShareRecordReward

The MsgWithdrawTokenizeShareRecordReward withdraws distribution rewards that have been distributed to the owner of a single tokenize share record.

// MsgWithdrawTokenizeShareRecordReward withdraws tokenize share rewards for a
// specific record
message MsgWithdrawTokenizeShareRecordReward {
  option (cosmos.msg.v1.signer) = "owner_address";
  option (amino.name) = "gaia/MsgWithdrawTokenizeShareRecordReward";

  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  string owner_address = 1 [ (gogoproto.moretags) = "yaml:\"owner_address\"" ];
  uint64 record_id = 2;
}

The message handling can fail if:

• Signer is not the owner of the tokenize share record.

MsgWithdrawAllTokenizeShareRecordReward

The MsgWithdrawAllTokenizeShareRecordReward withdraws distribution rewards that have been distributed to the owner for any tokenize share record they own.

// MsgWithdrawAllTokenizeShareRecordReward withdraws tokenize share rewards or
// all records owned by the designated owner
message MsgWithdrawAllTokenizeShareRecordReward {
  option (cosmos.msg.v1.signer) = "owner_address";
  option (amino.name) = "gaia/MsgWithdrawAllTokenizeShareRecordReward";

  option (gogoproto.equal) = false;
  option (gogoproto.goproto_getters) = false;

  string owner_address = 1 [ (gogoproto.moretags) = "yaml:\"owner_address\"" ];
}

The message handling can fail if:

• Signer is not the owner of the tokenize share record.

Begin-Block

RemoveExpiredTokenizeShareLocks

Each abci begin block call, the liquid module will prune expired tokenize share locks.

Events

The liquid module emits the following events:

Msg's

MsgTokenizeShares

Type	Attribute Key	Attribute Value
tokenize_shares	delegator_address	{delegatorAddress}
tokenize_shares	validator_address	{validatorAddress}
tokenize_shares	tokenized_share_owner	{tokenizedShareOwnerAddress}
tokenize_shares	amount	{tokenizeAmount}
message	module	liquid
message	action	tokenize_shares
message	sender	{senderAddress}

MsgRedeemTokensForShares

Type	Attribute Key	Attribute Value
redeem_tokens_for_shares	delegator_address	{delegatorAddress}
redeem_tokens_for_shares	amount	{redeemAmount}
message	module	liquid
message	action	redeem_tokens
message	sender	{senderAddress}

MsgTransferTokenizeShareRecord

Type	Attribute Key	Attribute Value
transfer_tokenize_share_record	tokenize_share_record_id	{shareRecordID}
transfer_tokenize_share_record	sender	{senderAddress}
transfer_tokenize_share_record	new_owner	{newShareOwnerAddress}
message	module	liquid
message	action	transfer-tokenize-share-record
message	sender	{senderAddress}

MsgEnableTokenizeShares

Type	Attribute Key	Attribute Value
enable_tokenize_shares	delegator_address	{delegatorAddress}
message	module	liquid
message	action	enable_tokenize_shares
message	sender	{senderAddress}

MsgDisableTokenizeShares

Type	Attribute Key	Attribute Value
disable_tokenize_shares	delegator_address	{delegatorAddress}
message	module	liquid
message	action	disable_tokenize_shares
message	sender	{senderAddress}

MsgWithdrawTokenizeShareRecordReward

Type	Attribute Key	Attribute Value
withdraw_tokenize_share_record_reward	owner_address	{ownerAddress}
withdraw_tokenize_share_record_reward	record_id	{recordID}
message	module	liquid
message	action	withdraw_tokenize_share_record_reward
message	sender	{senderAddress}

MsgWithdrawAllTokenizeShareRecordReward

Type	Attribute Key	Attribute Value
withdraw_all_tokenize_share_record_reward	owner_address	{ownerAddress}
message	module	liquid
message	action	withdraw_all_tokenize_share_record_reward
message	sender	{senderAddress}

Parameters

The liquid module contains the following parameters:

Key	Type	Example
GlobalLiquidStakingCap	string	"1.000000000000000000"
ValidatorLiquidStakingCap	string	"0.250000000000000000"

Client

CLI

A user can query and interact with the liquid module using the CLI.

Query

The query commands allows users to query liquid state.

gaiad query liquid --help

The all-tokenize-share-records command allows users to query all tokenize share records.

Usage:

gaiad query liquid all-tokenize-share-records [flags]

Example:

gaiad query liquid all-tokenize-share-records

Example Output:

pagination:
  total: "1"
records:
- id: "1"
  module_account: tokenizeshare_1
  owner: cosmos1dw6s9qsz4uh42j3cgapyfm3tu83qafchy2srez
  validator: cosmosvaloper1dw6s9qsz4uh42j3cgapyfm3tu83qafchp7yk43

The last-tokenize-share-record-id command allows users to query the last tokenize share record ID issued.

Usage:

gaiad query liquid last-tokenize-share-record-id [flags]

Example:

gaiad query liquid last-tokenize-share-record-id

Example Output:

id: "2"

The params command allows users to query the current module params.

Usage:

gaiad query liquid params [flags]

Example:

gaiad query liquid params

Example Output:

params:
  global_liquid_staking_cap: "0.250000000000000000"
  validator_liquid_staking_cap: "1.000000000000000000"

The tokenize-share-lock-info command allows users to query the current tokenization lock status for a given account.

Usage:

gaiad query liquid tokenize-share-lock-info [account-addr] [flags]

Example:

gaiad query liquid tokenize-share-lock-info cosmos1dw6s9qsz4uh42j3cgapyfm3tu83qafchy2srez

Example Output:

status: TOKENIZE_SHARE_LOCK_STATUS_UNLOCKED

The tokenize-share-record-by-denom command allows users to query the tokenize share record information for the provided denom.

Usage:

gaiad query liquid tokenize-share-record-by-denom [denom] [flags]

Example:

gaiad query liquid tokenize-share-record-by-denom cosmosvaloper1vuvl27z833dksv89vz2205mrwhadez3k3egzrh/1

Example Output:

record:
  id: "1"
  module_account: tokenizeshare_1
  owner: cosmos15ty20clrlwmph2v8k7qzr4lklpz883zdd89ckp
  validator: cosmosvaloper1vuvl27z833dksv89vz2205mrwhadez3k3egzrh

The tokenize-share-record-by-id command allows users to query the tokenize share record information for the provided record ID.

Usage:

gaiad query liquid tokenize-share-record-by-id [ID] [flags]

Example:

gaiad query liquid tokenize-share-record-by-id 1

Example Output:

record:
  id: "1"
  module_account: tokenizeshare_1
  owner: cosmos15ty20clrlwmph2v8k7qzr4lklpz883zdd89ckp
  validator: cosmosvaloper1vuvl27z833dksv89vz2205mrwhadez3k3egzrh

The tokenize-share-record-rewards command allows users to query the rewards for the provided record owner.

Usage:

gaiad query liquid tokenize-share-record-rewards [owner-addr] [flags]

Example:

gaiad query liquid tokenize-share-record-rewards cosmos15ty20clrlwmph2v8k7qzr4lklpz883zdd89ckp

Example Output:

rewards:
  - record_id: "1"
  reward:
  - 1496874162.803718702000000000stake
  - 2.155511221800000000uatom
total:
- 1496874162.803718702000000000stake
- 2.155511221800000000uatom

The tokenize-share-records-owned command allows users to query the records account address.

Usage:

gaiad query liquid tokenize-share-records-owned [owner-addr] [flags]

Example:

gaiad query liquid tokenize-share-records-owned cosmos15ty20clrlwmph2v8k7qzr4lklpz883zdd89ckp

Example Output:

records:
- id: "1"
  module_account: tokenizeshare_1
  owner: cosmos15ty20clrlwmph2v8k7qzr4lklpz883zdd89ckp
  validator: cosmosvaloper1vuvl27z833dksv89vz2205mrwhadez3k3egzrh

The total-liquid-staked command allows users to query the total amount of tokens liquid staked.

Usage:

gaiad query liquid total-liquid-staked [flags]

Example:

gaiad query liquid total-liquid-staked

Example Output:

tokens: "200000000"

The total-tokenize-share-assets command allows users to query the total amount of tokenized assets.

Usage:

gaiad query liquid total-tokenize-share-assets [flags]

Example:

gaiad query liquid total-tokenize-share-assets

Example Output:

value:
  amount: "200000000"
  denom: uatom

Transactions

The tx commands allows users to interact with the liquid module.

gaiad tx liquid --help

The command disable-tokenize-shares allows users to disable tokenization for their account.

Usage:

gaiad tx liquid disable-tokenize-shares [flags]

Example:

gaiad tx liquid disable-tokenize-shares --from=mykey

The command enable-tokenize-shares allows users to enable tokenization for their account.

Usage:

gaiad tx liquid enable-tokenize-shares [flags]

Example:

gaiad tx liquid enable-tokenize-shares --from=mykey

The command redeem-tokens allows users to convert a specified amount of tokenized shares for the underlying delegation.

Usage:

gaiad tx liquid redeem-tokens [amount] [flags]

Example:

gaiad tx liquid redeem-tokens 10000cosmosvaloper1vuvl27z833dksv89vz2205mrwhadez3k3egzrh/1

The command tokenize-share allows users to convert a delegation into tokenized shares.

Usage:

gaiad tx liquid tokenize-share [validator-addr] [amount] [rewardOwner] [flags]

Example:

gaiad tx liquid tokenize-share cosmosvaloper1vuvl27z833dksv89vz2205mrwhadez3k3egzrh 1000uatom cosmos15ty20clrlwmph2v8k7qzr4lklpz883zdd89ckp

The command transfer-tokenize-share-record allows users to transfer a tokenize share record to another owner.

Usage:

gaiad tx liquid transfer-tokenize-share-record [record-id] [new-owner] [flags]

Example:

gaiad tx liquid transfer-tokenize-share-record 1 cosmos15ty20clrlwmph2v8k7qzr4lklpz883zdd89ckp

The command withdraw-all-tokenize-share-rewards allows users to withdraw all rewards for their tokenized shares.

Usage:

gaiad tx liquid withdraw-all-tokenize-share-rewards [flags]

Example:

gaiad tx liquid withdraw-all-tokenize-share-rewards --from=myKey

The command withdraw-tokenize-share-rewards allows users to withdraw rewards for a tokenize share record.

Usage:

gaiad tx liquid withdraw-tokenize-share-rewards [record-id] [flags]

Example:

gaiad tx liquid withdraw-all-tokenize-share-rewards 1 --from=myKey

gRPC

A user can query the liquid module using gRPC endpoints.

LiquidValidator

The LiquidValidator endpoint queries for a single validator's liquid shares.

gaia.liquid.v1beta1.Query/LiquidValidator

Example:

grpcurl -plaintext -d '{"validator_addr": "cosmosvaloper12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr"}' \
localhost:9090 gaia.liquid.v1beta1.Query/LiquidValidator

Example Output:

{
  "liquidValidator": {
    "operatorAddress": "cosmosvaloper12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr",
    "liquidShares": "20000"
  }
}

AllTokenizeShareRecords

The AllTokenizeShareRecords endpoint queries all tokenize share records.

gaia.liquid.v1beta1.Query/AllTokenizeShareRecords

Example:

grpcurl -plaintext localhost:9090 gaia.liquid.v1beta1.Query/AllTokenizeShareRecords

Example Output:

{
  "records": [
    {
      "id": "1",
      "owner": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr",
      "moduleAccount": "tokenizeshare_1",
      "validator": "cosmosvaloper1jd9slc386vepwpamrrgzkpflhfy94mhqcf0sre"
    }
  ],
  "pagination": {
    "total": "1"
  }
}

LastTokenizeShareRecordId

The LastTokenizeShareRecordId endpoint queries the last tokenize share record ID issued.

gaia.liquid.v1beta1.Query/LastTokenizeShareRecordId

Example:

grpcurl -plaintext localhost:9090 gaia.liquid.v1beta1.Query/LastTokenizeShareRecordId

Example Output:

{
  "id": "1"
}

TokenizeShareLockInfo

The TokenizeShareLockInfo endpoint queries the current tokenization lock status for a given account.

gaia.liquid.v1beta1.Query/TokenizeShareLockInfo

Example:

grpcurl -plaintext -d '{"address": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr"}' \
localhost:9090 gaia.liquid.v1beta1.Query/TokenizeShareLockInfo

Example Output:

{
  "status": "TOKENIZE_SHARE_LOCK_STATUS_UNLOCKED"
}

TokenizeShareRecordByDenom

The TokenizeShareRecordByDenom endpoint queries the tokenize share record information for the provided denom.

gaia.liquid.v1beta1.Query/TokenizeShareRecordByDenom

Example:

grpcurl -plaintext -d '{"denom": "cosmosvaloper1jd9slc386vepwpamrrgzkpflhfy94mhqcf0sre/1"}' \
localhost:9090 gaia.liquid.v1beta1.Query/TokenizeShareRecordByDenom

Example Output:

{
  "record": {
    "id": "1",
    "owner": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr",
    "moduleAccount": "tokenizeshare_1",
    "validator": "cosmosvaloper1jd9slc386vepwpamrrgzkpflhfy94mhqcf0sre"
  }
}

TokenizeShareRecordById

The TokenizeShareRecordById endpoint queries the tokenize share record information for the provided record ID.

gaia.liquid.v1beta1.Query/TokenizeShareRecordById

Example:

grpcurl -plaintext -d '{"id": "1"}' \
localhost:9090 gaia.liquid.v1beta1.Query/TokenizeShareRecordById

Example Output:

{
  "record": {
    "id": "1",
    "owner": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr",
    "moduleAccount": "tokenizeshare_1",
    "validator": "cosmosvaloper1jd9slc386vepwpamrrgzkpflhfy94mhqcf0sre"
  }
}

TokenizeShareRecordReward

The TokenizeShareRecordReward endpoint queries the rewards for the provided record owner.

gaia.liquid.v1beta1.Query/TokenizeShareRecordReward

Example:

grpcurl -plaintext -d '{"owner_address": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr"}' \
localhost:9090 gaia.liquid.v1beta1.Query/TokenizeShareRecordReward

Example Output:

{
  "rewards": [
    {
      "recordId": "1",
      "reward": [
        {
          "denom": "stake",
          "amount": "8588380036928696253000000000"
        },
        {
          "denom": "uatom",
          "amount": "2155511221800000000"
        }
      ]
    }
  ],
  "total": [
    {
      "denom": "stake",
      "amount": "8588380036928696253000000000"
    },
    {
      "denom": "uatom",
      "amount": "2155511221800000000"
    }
  ]
}

TokenizeShareRecordsOwned

The TokenizeShareRecordsOwned command allows users to query the records account address.

gaia.liquid.v1beta1.Query/TokenizeShareRecordsOwned

Example:

grpcurl -plaintext -d '{"owner": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr"}' \
localhost:9090 gaia.liquid.v1beta1.Query/TokenizeShareRecordsOwned

Example Output:

{
  "records": [
    {
      "id": "1",
      "owner": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr",
      "moduleAccount": "tokenizeshare_1",
      "validator": "cosmosvaloper1jd9slc386vepwpamrrgzkpflhfy94mhqcf0sre"
    }
  ]
}

TotalLiquidStaked

The TotalLiquidStaked endpoint queries the total amount of tokens liquid staked.

gaia.liquid.v1beta1.Query/TotalLiquidStaked

Example:

grpcurl -plaintext localhost:9090 gaia.liquid.v1beta1.Query/TotalLiquidStaked

Example Output:

{
  "tokens": "200000000"
}

TotalTokenizeSharedAssets

The TotalTokenizeSharedAssets endpoint queries the total amount of tokenized assets.

gaia.liquid.v1beta1.Query/TotalTokenizeSharedAssets

Example:

grpcurl -plaintext localhost:9090 gaia.liquid.v1beta1.Query/TotalTokenizeSharedAssets

Example Output:

{
  "value": {
    "denom": "uatom",
    "amount": "200000000"
  }
}

Params

The Params endpoint queries the module Params.

gaia.liquid.v1beta1.Query/Params

Example:

grpcurl -plaintext localhost:9090 gaia.liquid.v1beta1.Query/Params

Example Output:

{
  "params": {
    "globalLiquidStakingCap": "250000000000000000",
    "validatorLiquidStakingCap": "500000000000000000"
  }
}

REST

A user can query the liquid module using REST endpoints.

AllTokenizeShareRecords

The AllTokenizeShareRecords REST endpoint queries all tokenize share records.

/gaia/liquid/v1beta1/tokenize_share_records

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/tokenize_share_records" -H  "accept: application/json"

Example Output:

{
  "delegation_responses": [
    {
      "delegation": {
        "delegator_address": "cosmos1vcs68xf2tnqes5tg0khr0vyevm40ff6zdxatp5",
        "validator_address": "cosmosvaloper1quqxfrxkycr0uzt4yk0d57tcq3zk7srm7sm6r8",
        "shares": "256250000.000000000000000000"
      },
      "balance": {
        "denom": "stake",
        "amount": "256250000"
      }
    },
    {
      "delegation": {
        "delegator_address": "cosmos1vcs68xf2tnqes5tg0khr0vyevm40ff6zdxatp5",
        "validator_address": "cosmosvaloper194v8uwee2fvs2s8fa5k7j03ktwc87h5ym39jfv",
        "shares": "255150000.000000000000000000"
      },
      "balance": {
        "denom": "stake",
        "amount": "255150000"
      }
    }
  ],
  "pagination": {
    "next_key": null,
    "total": "2"
  }
}

LastTokenizeShareRecordId

The LastTokenizeShareRecordId REST endpoint queries the last tokenize share record ID issued.

/gaia/liquid/v1beta1/last_tokenize_share_record_id

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/last_tokenize_share_record_id" -H  "accept: application/json"

Example Output:

{
  "id": "1"
}

TokenizeShareLockInfo

The TokenizeShareLockInfo REST endpoint queries the current tokenization lock status for a given account.

/gaia/liquid/v1beta1/tokenize_share_lock_info/{address}

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/tokenize_share_lock_info/cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr" -H  "accept: application/json"

Example Output:

{
  "status": "TOKENIZE_SHARE_LOCK_STATUS_UNLOCKED",
  "expiration_time": ""
}

TokenizeShareRecordById

The TokenizeShareRecordById REST endpoint queries the tokenize share record information for the provided record ID.

/gaia/liquid/v1beta1/tokenize_share_record_by_id/{id}

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/tokenize_share_record_by_id/1" -H  "accept: application/json"

Example Output:

{
  "record": {
    "id": "1",
    "owner": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr",
    "module_account": "tokenizeshare_1",
    "validator": "cosmosvaloper1jd9slc386vepwpamrrgzkpflhfy94mhqcf0sre"
  }
}

TokenizeShareRecordReward

The TokenizeShareRecordReward REST endpoint queries the rewards for the provided record owner.

/gaia/liquid/v1beta1/{owner_address}/tokenize_share_record_rewards

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr/tokenize_share_record_rewards" -H  "accept: application/json"

Example Output:

{
  "rewards": [
    {
      "record_id": "1",
      "reward": [
        {
          "denom": "stake",
          "amount": "392793740917.315504955400000000"
        },
        {
          "denom": "uatom",
          "amount": "2.155511221800000000"
        }
      ]
    }
  ],
  "total": [
    {
      "denom": "stake",
      "amount": "392793740917.315504955400000000"
    },
    {
      "denom": "uatom",
      "amount": "2.155511221800000000"
    }
  ]
}

TokenizeShareRecordsOwned

The TokenizeShareRecordsOwned REST endpoint queries the records account address.

/gaia/liquid/v1beta1/tokenize_share_record_owned/{owner}

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/tokenize_share_record_owned/cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr" -H  "accept: application/json"

Example Output:

{
  "records": [
    {
      "id": "1",
      "owner": "cosmos12xw6ylce2enratz3m942xd9jnjc4qrkk0yqnmr",
      "module_account": "tokenizeshare_1",
      "validator": "cosmosvaloper1jd9slc386vepwpamrrgzkpflhfy94mhqcf0sre"
    }
  ]
}

TotalLiquidStaked

The TotalLiquidStaked REST endpoint queries the total amount of tokens liquid staked.

/gaia/liquid/v1beta1/total_liquid_staked

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/total_liquid_staked" -H  "accept: application/json"

Example Output:

{
  "tokens": "200000000"
}

TotalTokenizeSharedAssets

The TotalTokenizeSharedAssets REST endpoint queries the total amount of tokenized assets.

/gaia/liquid/v1beta1/total_tokenize_shared_assets

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/total_tokenize_shared_assets" -H  "accept: application/json"

Example Output:

{
  "value": {
    "denom": "uatom",
    "amount": "200000000"
  }
}

Params

The Params REST endpoint queries the module Params.

/gaia/liquid/v1beta1/params

Example:

curl -X GET "http://localhost:1317/gaia/liquid/v1beta1/params" -H  "accept: application/json"

Example Output:

{
  "params": {
    "global_liquid_staking_cap": "0.250000000000000000",
    "validator_liquid_staking_cap": "0.500000000000000000"
  }
}