itc

package
v5.0.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 26, 2024 License: MIT Imports: 17 Imported by: 0

README

ITC (Interact To Claim)

Abstract

The ITC module is designed to enable any account to create campaigns with different types of claims and interactions. Campaigns can be used to distribute fungible tokens or NFTs to users who interact with them using NFTs.

After successfully interacting with a campaign, the claimer will receive the following rewards based on the claim type:

  • If the claim type is CLAIM_TYPE_FT, the per-claim amount will be distributed to the claimer according to the distribution type.
  • If the claim type is CLAIM_TYPE_NFT, an NFT will be minted and sent to the claimer address.
  • If the claim type is CLAIM_TYPE_FT_AND_NFT, both an amount and an NFT will be sent to the claimer address.
Campaign Types

There are three campaign types that can be created using the ITC module:

  • Fungible token claim campaign (CLAIM_TYPE_FT): Users can claim fungible tokens by interacting with the campaign using NFTs.
  • Non-fungible token claim campaign (CLAIM_TYPE_NFT): Users can claim NFTs by interacting with the campaign using NFTs.
  • Both fungible and non-fungible token claim campaign (CLAIM_TYPE_FT_AND_NFT): Users can claim both fungible tokens and NFTs by interacting with the campaign using NFTs.
Interaction Types

There are three interaction types that can be used in the ITC module:

  • Burn NFT (INTERACTION_TYPE_BURN): The NFT will be burned after the claim is made.
  • Transfer NFT (INTERACTION_TYPE_TRANSFER): The NFT will be transferred to the campaign owner after the claim is made.
  • Hold NFT (INTERACTION_TYPE_HOLD): The user must hold ownership of the NFT to be able to make a claim.

State

Module State

The initial state of the module. It contains information about all campaigns, claims, and parameters of the module.

message GenesisState {
  repeated Campaign campaigns = 1 [(gogoproto.nullable) = false];
  uint64 next_campaign_number = 2;
  repeated Claim claims = 3 [(gogoproto.nullable) = false];
  Params params = 4 [(gogoproto.nullable) = false];
}
Campaign

A campaign created by a user to distribute tokens to other users who perform certain interactions. It has a name, description, start and end time, maximum number of allowed claims, interaction type, claim type, tokens per claim, total tokens, available tokens, received NFT IDs, NFT mint details, distribution, and creator.

message Campaign {
  uint64 id = 1;
  string name = 2;
  string description = 3;
  google.protobuf.Timestamp start_time = 4 [
    (gogoproto.nullable) = false,
    (gogoproto.stdtime) = true,
    (gogoproto.moretags) = "yaml:\"start_time\""
  ];
  google.protobuf.Timestamp end_time = 5 [
    (gogoproto.nullable) = false,
    (gogoproto.stdtime) = true,
    (gogoproto.moretags) = "yaml:\"end_time\""
  ];
  string creator = 6;
  string nft_denom_id = 7 [(gogoproto.moretags) = "yaml:\"nft_denom_id\""];
  uint64 max_allowed_claims = 8
  [(gogoproto.moretags) = "yaml:\"max_allowed_claims\""];
  InteractionType interaction = 9;
  ClaimType claim_type = 10;
  cosmos.base.v1beta1.Coin tokens_per_claim = 11 [
    (gogoproto.nullable) = false,
    (gogoproto.moretags) = "yaml:\"tokens_per_claim\""
  ];
  cosmos.base.v1beta1.Coin total_tokens = 12 [
    (gogoproto.nullable) = false,
    (gogoproto.moretags) = "yaml:\"total_tokens\""
  ];
  cosmos.base.v1beta1.Coin available_tokens = 13 [
    (gogoproto.nullable) = false,
    (gogoproto.moretags) = "yaml:\"available_tokens\""
  ];
  repeated string received_nft_ids = 14
  [(gogoproto.moretags) = "yaml:\"received_nft_ids\""];
  NFTDetails nft_mint_details = 15
  [(gogoproto.moretags) = "yaml:\"nft_mint_details\""];
  Distribution distribution = 16
  [(gogoproto.moretags) = "yaml:\"distribution\""];
  uint64 mint_count = 17 [(gogoproto.moretags) = "yaml:\"mint_count\""];
}
Claim

A claim made by a user for a campaign by providing their address, NFT ID, and interaction type.

message Claim {
  uint64     campaign_id = 1;
  string     address = 2;
  string     nft_id = 3;
  InteractionType interaction = 4;
}
Parameters

The parameters of the module, which include the maximum campaign duration and creation fee.

message Params {
  google.protobuf.Duration max_campaign_duration = 1 [
    (gogoproto.nullable) = false,
    (gogoproto.stdduration) = true,
    (gogoproto.moretags) = "yaml:\"max_campaign_duration\""
  ];
  cosmos.base.v1beta1.Coin creation_fee = 2 [
    (gogoproto.nullable) = false,
    (gogoproto.moretags) = "yaml:\"creation_fee\""
  ];
}

Messages

CreateCampaign

MsgCreateCampaign can be used by any account to create a new Campaign

message MsgCreateCampaign {
  string                      name = 1;
  string                      description = 2;
  InteractionType             interaction = 3;
  ClaimType                   claim_type = 4 [(gogoproto.moretags) = "yaml:\"claim_type\""];
  string                      nft_denom_id = 5 [(gogoproto.moretags) = "yaml:\"nft_denom_id\""];
  cosmos.base.v1beta1.Coin                      tokens_per_claim = 6 [
    (gogoproto.nullable) = false,
    (gogoproto.moretags) = "yaml:\"tokens_per_claim\""
  ];
  uint64                      max_allowed_claims = 7 [
    (gogoproto.moretags) = "yaml:\"max_allowed_claims\""
  ];
  cosmos.base.v1beta1.Coin                      deposit = 8 [
    (gogoproto.nullable) = false,
    (gogoproto.moretags) = "yaml:\"deposit\""
  ];
  NFTDetails                  nft_mint_details = 9 [(gogoproto.moretags) = "yaml:\"nft_details\""];
  google.protobuf.Timestamp   start_time = 10 [
    (gogoproto.nullable) = false,
    (gogoproto.stdtime) = true,
    (gogoproto.moretags) = "yaml:\"start_time\""
  ];

  google.protobuf.Duration     duration = 11 [
    (gogoproto.nullable) = false,
    (gogoproto.stdduration) = true
  ];

  Distribution            distribution = 12;
  string                       creator = 13;
  cosmos.base.v1beta1.Coin     creation_fee = 14 [
    (gogoproto.nullable) = false,
    (gogoproto.moretags) = "yaml:\"creation_fee\""
  ];
}
CancelCampaign

MsgCancelCampaign can be used by the creator to cancel the upcoming Campaign.

message MsgCancelCampaign {
    uint64 campaign_id = 1;
    string creator = 2;
}
DepositCampaign

MsgDepositCampaign can be used by creator to add funds to the Campaign.

message MsgDepositCampaign {
    uint64 campaign_id = 1;
    cosmos.base.v1beta1.Coin amount = 2 [(gogoproto.nullable) = false];
    string depositor = 3;
}
Claim

MsgClaim can be used by any account to claim amount/nft from the Campaign by interacting with nft

message MsgClaim {
    uint64 campaign_id = 1;
    string nft_id = 2;
    InteractionType interaction = 3;
    string claimer = 4;
}

Transactions

Create a new campaign

This transaction creates a new campaign with the specified parameters:

omniflixhubd tx itc create-campaign \
  --name="campaign name" \
  --description="campaign description" \
  --start-time="2023-05-10T10:20:00Z" \
  --duration="3600s" \
  --claim-type=fungible \
  --max-allowed-claims=10 \
  --tokens-per-claim=10000000uflix \
  --deposit=100000000uflix  \
  --interaction-type=transfer \
  --nft-denom-id=nftdenomid \
  --distribution-type stream \
  --stream-duration "600s" \
  --creation-fee 10000000uflix \
  --fees=200uflix \
  --chain-id=omniflixhub-1 \
  --from=wallet

interaction types: burn, transfer & hold claim types: fungible, nonfungible & fungible-and-non-fungible

example for nft type claim

omniflixhubd tx itc create-campaign \
  --name="campaign name" \
  --description="campaign description" \
  --start-time="2023-05-10T10:20:00Z" \
  --duration="3600s" \
  --claim-type=nonfungible \
  --max-allowed-claims=10 \
  --interaction-type=transfer \
  --nft-denom-id=nftdenomid \
  --nft-details-file="nft-mint-details-file-path" \
  --creation-fee 10000000uflix \
  --fees=200uflix \
  --chain-id=omniflixhub-1 \
  --from=wallet
Cancel campaign

This transaction cancels a campaign with the specified campaign ID:

omniflixhubd tx itc cancel-campaign <campaign-id> --from wallet
Deposit amount in campaign

This transaction deposits a specified amount into a campaign with the specified campaign ID:

omniflixhubd tx itc campaign-deposit <campaign-id> \
  --amount 1000000uflix \
  --fees=200uflix \
  --chain-id=omniflixhub-1 \
  --from=wallet
Claim from campaign

This transaction claims a token or NFT from the specified campaign:

omniflixhubd tx itc claim <campaign-id> \
  --nft-id="nft-id" \
  --interaction-type=<interaction-type> \
  --fees=200uflix \
  --chain-id=omniflixhub-1 \
  --from=wallet

Note: Replace the values enclosed in < and > with the actual values.

Queries

The ITC module provides several queries to fetch information related to campaigns, claims, and module parameters.

service Query {
  rpc Params(QueryParamsRequest) returns (QueryParamsResponse) {
    option (google.api.http).get = "/omniflix/itc/v1/params";
  }

  rpc Campaigns(QueryCampaignsRequest) returns (QueryCampaignsResponse) {
    option (google.api.http).get = "/omniflix/itc/v1/campaigns";
  }

  rpc Campaign(QueryCampaignRequest) returns (QueryCampaignResponse) {
    option (google.api.http).get = "/omniflix/itc/v1/campaigns/{campaign_id}";
  }

  rpc Claims(QueryClaimsRequest) returns (QueryClaimsResponse) {
    option (google.api.http).get = "/omniflix/itc/v1/claims";
  }
}

The available queries are:

  • Params: Returns the current module parameters.
  • Campaigns: Returns a list of all campaigns.
  • Campaign: Returns information about a specific campaign by its ID.
  • Claims: Returns a list of all claims for a specific campaign.

To execute the queries, you can use the following commands:

Query all campaigns
omniflixhubd q itc campaigns
Query campaign by ID
omniflixhubd q itc campaign <campaign-id>
Query claims of a campaign
omniflixhubd q itc claims <campaign-id>
Query module parameters
omniflixhubd q itc params

Documentation

Index

Constants

View Source 
const ConsensusVersion = 2

ConsensusVersion defines the current x/itc module consensus version.

Variables

This section is empty.

Functions

func DefaultGenesisState 

func DefaultGenesisState() *types.GenesisState

DefaultGenesisState returns default state

func EndBlock 

func EndBlock(ctx sdk.Context, k keeper.Keeper) []abcitypes.ValidatorUpdate

func ExportGenesis 

func ExportGenesis(ctx sdk.Context, k keeper.Keeper) *types.GenesisState

ExportGenesis exports state

func InitGenesis 

func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState)

InitGenesis initializes state

Types

type AppModule 

type AppModule struct {
	AppModuleBasic
	// contains filtered or unexported fields
}

AppModule implements the AppModule interface for the itc module.

func NewAppModule 

func NewAppModule(cdc codec.Codec, keeper keeper.Keeper, ss exported.Subspace) AppModule

func (AppModule) ConsensusVersion 

func (AppModule) ConsensusVersion() uint64

ConsensusVersion implements ConsensusVersion.

func (AppModule) ExportGenesis 

func (am AppModule) ExportGenesis(ctx sdk.Context, cdc codec.JSONCodec) json.RawMessage

ExportGenesis returns the itc module's exported genesis state as raw JSON bytes.

func (AppModule) InitGenesis 

func (am AppModule) InitGenesis(ctx sdk.Context, cdc codec.JSONCodec, gs json.RawMessage) []abci.ValidatorUpdate

InitGenesis performs the itc module's genesis initialization It returns no validator updates.

func (AppModule) IsAppModule 

func (am AppModule) IsAppModule()

IsAppModule implements the appmodule.AppModule interface.

func (AppModule) IsOnePerModuleType 

func (am AppModule) IsOnePerModuleType()

IsOnePerModuleType is a marker function just indicates that this is a one-per-module type.

func (AppModule) Name 

func (am AppModule) Name() string

Name returns the itc module's name.

func (AppModule) QuerierRoute 

func (AppModule) QuerierRoute() string

QuerierRoute returns the itc module's query routing key.

func (AppModule) RegisterInvariants 

func (am AppModule) RegisterInvariants(_ sdk.InvariantRegistry)

RegisterInvariants registers the itc module's invariants.

func (AppModule) RegisterServices 

func (am AppModule) RegisterServices(cfg module.Configurator)

RegisterServices registers a GRPC query service to respond to the module-specific GRPC queries.

type AppModuleBasic 

type AppModuleBasic struct {
	// contains filtered or unexported fields
}

AppModuleBasic implements the AppModuleBasic interface for the itc module.

func NewAppModuleBasic 

func NewAppModuleBasic(cdc codec.BinaryCodec) AppModuleBasic

func (AppModuleBasic) DefaultGenesis 

func (AppModuleBasic) DefaultGenesis(cdc codec.JSONCodec) json.RawMessage

DefaultGenesis returns the itc module's default genesis state.

func (AppModuleBasic) GetQueryCmd 

func (AppModuleBasic) GetQueryCmd() *cobra.Command

GetQueryCmd returns the itc module's root query command.

func (AppModuleBasic) GetTxCmd 

func (a AppModuleBasic) GetTxCmd() *cobra.Command

GetTxCmd returns the itc module's root tx command.

func (AppModuleBasic) Name 

func (AppModuleBasic) Name() string

Name returns the itc module's name.

func (AppModuleBasic) RegisterGRPCGatewayRoutes 

func (AppModuleBasic) RegisterGRPCGatewayRoutes(clientCtx client.Context, mux *runtime.ServeMux)

RegisterGRPCGatewayRoutes registers the gRPC Gateway routes for the module.

func (AppModuleBasic) RegisterInterfaces 

func (a AppModuleBasic) RegisterInterfaces(reg cdctypes.InterfaceRegistry)

RegisterInterfaces registers the module's interface types

func (AppModuleBasic) RegisterLegacyAminoCodec 

func (AppModuleBasic) RegisterLegacyAminoCodec(cdc *codec.LegacyAmino)

func (AppModuleBasic) RegisterRESTRoutes 

func (AppModuleBasic) RegisterRESTRoutes(_ client.Context, _ *mux.Router)

RegisterRESTRoutes registers the itc module's REST service handlers.

func (AppModuleBasic) ValidateGenesis 

func (AppModuleBasic) ValidateGenesis(cdc codec.JSONCodec, _ client.TxEncodingConfig, bz json.RawMessage) error

ValidateGenesis performs genesis state validation for the itc module.

Source Files

View all Source files

Directories

Path Synopsis
client
cli
migrations
v2
Package types is a reverse proxy.
 Package types is a reverse proxy.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.