Skip to content

fomowell/document

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
README.md
README.md
 
 

Repository files navigation

FomoWell

FomoWell Launcher

The Launcher is used to launch the Fomowell project and searching FOMO projects.

Endpoint 1: create_fomo

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  create_fomo : (FomoProjectCreate) -> (Result)
  • Request parameters:
Order Name Description
1 name Fomo full name
2 ticker Fomo ticker
3 description Fomo description
4 img_url Fomo image hash
5 logo The hash generated by uploading the image
6 twitter_link Fomo Twitter Link
7 telegram_link Fomo Telegram Link
8 website Fomo Official Site
9 sneed_dao_lock You can choose to lock 10%-50% of the LP into Sneed DAO
  • Response parameters:
Order Name Description
1 fomo_idx Fomo index
2 name Fomo Name
3 ticker Fomo Ticker
4 description Fomo Description
5 img_url Fomo image hash
6 twitter_link Fomo Twitter Link
7 telegram_link Fomo Telegram Link
8 website Fomo Official Website
9 token_pid Fomo token Principal ID
10 pool_pid Fomo pool principal ID
11 fomo_pid Store comments and metadata
12 pool_progress Pool completion progress
13 pool_progress_done_time Pool progress completion time
14 god_of_wells_progress God of wells Progress
15 god_of_wells_time God of wells completion time
16 market_cap Market capitalization
17 create_time Fomo creation time
18 create_user_pid Creator's principal ID
19 reply_count Fomo reply Count
20 recently_reply_time Time of the most recent comment
21 recently_bump_time Time of the most recent bump

Endpoint 2: edit_user

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  edit_user : (UserEditObj) -> (Result_1);
  • Request parameters:
Order Name Description
1 user_name Edit user name or not
2 avatar Edit avatar(image hash) or not
  • Response parameters:
Order Name Description
1 result Edit user principal ID

Endpoint 3: get_addr_config

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  get_addr_config : () -> (AddrConfig) query;
  • Request parameters:
  • Response parameters:
Order Name Description
1 backend_addr ICPEx backend canisterId
2 router_addr ICPEx router canisterId
3 deprecated_pid
4 oracle_addr ICPEx oracle canisterId
5 tx_addr ICPEx transaction canisterId

Endpoint 4: get_buy_or_sell

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  get_buy_or_sell : () -> (RecordSignalVo) query;

  • Request parameters:

  • Response parameters:

Order Name Description
1 fomo_idx Fomo index id
2 fomo_ticker Fomo token ticker
3 icp_amount Transaction amount
4 buy_sell_op Operation type (buy/sell)
5 op_user_pid Operator user principal ID
6 user_name User name
7 user_avatar User avatar(Hash)
8 swap_timestamp Transaction timestamp

Endpoint 5: get_fomo_by_fomo_idx

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  get_fomo_by_fomo_idx : (nat64) -> (opt FomoProject) query;
  • Request parameters:
Order Name Description
1 fomo_idx Fomo index id
  • Response parameters:
Order Name Description
1 fomo_idx Fomo index
2 name Fomo Name
3 ticker Fomo Ticker
4 description Fomo Description
5 img_url Fomo image hash
6 twitter_link Fomo twitter link
7 telegram_link Fomo telegram link
8 website Fomo official website
9 token_pid Fomo token Principal ID
10 pool_pid Fomo pool principal ID
11 fomo_pid Store comments and metadata
12 pool_progress Pool completion progress
13 pool_progress_done_time Pool progress completion time
14 god_of_wells_progress God of wells Progress
15 god_of_wells_time God of wells completion time
16 market_cap Market capitalization
17 create_time Fomo creation time
18 create_user_pid Creator's principal ID
19 reply_count Fomo reply Count
20 recently_reply_time Time of the most recent comment
21 recently_bump_time Time of the most recent bump

Endpoint 6: get_fomo_by_fomo_pid

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  get_fomo_by_fomo_pid : (principal) -> (opt FomoProject) query;
  • Request parameters:
Order Name Description
1 fomo_idx Fomo index id
  • Response parameters:
Order Name Description
1 fomo_idx Fomo index id
2 name Fomo Name
3 ticker Fomo Ticker
4 description Fomo Description
5 img_url Fomo image hash
6 twitter_link Fomo twitter link
7 telegram_link Fomo telegram link
8 website Fomo official website
9 token_pid Fomo token Principal ID
10 pool_pid Fomo pool principal ID
11 fomo_pid Store comments and metadata
12 pool_progress Pool completion progress
13 pool_progress_done_time Pool progress completion time
14 god_of_wells_progress God of wells Progress
15 god_of_wells_time God of wells completion time
16 market_cap Market capitalization
17 create_time Fomo creation time
18 create_user_pid Creator's principal ID
19 reply_count Fomo reply Count
20 recently_reply_time Time of the most recent comment
21 recently_bump_time Time of the most recent bump

Endpoint 7: get_fomo_by_index

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
   get_fomo_by_index : (Page) -> (FomoProjectVo) query;
  • Request parameters:
Order Field Description
1 start Starting index of the query
2 limit Maximum number of items to return
  • Response parameters:
Order Field1 Field2 Description
1 start_idx Starting index of the list
2 end_idx Ending index of the list
3 fomo_vec fomo_idx Fomo index id
4 name Fomo Name
5 ticker Fomo Ticker
6 description Fomo description
7 img_url Fomo image hash
8 twitter_link Fomo twitter link
9 telegram_link Fomo telegram link
10 website Fomo official website
11 token_pid Fomo token canister PID
12 pool_pid Fomo Pool canister PID
13 fomo_pid Fomo canister PID
14 pool_progress Pool completion progress
15 pool_progress_done_time Pool progress completion time
16 god_of_wells_progress God of wells Progress
17 god_of_wells_time God of wells completion time
18 market_cap Market capitalization
19 create_time Fomo creation time
20 create_user_pid Creator's PID
21 reply_count Reply Count
22 recently_reply_time Time of the most recent comment
23 recently_bump_time Time of the most recent bump

Endpoint 8: get_fomo_context

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
   () -> (Context) query;
  • Request parameters:
  • Response parameters:
Order Field1 Field2 Description
1 owner FOMO Owner's PID
2 fomo_canister_template Null
3 icp_addr ICP canisterID
4 god_of_wells_idx God of wells ID
5 last_buy_sell_op fomo_idx Last buy or sell FOMO ID
6 fomo_ticker Last buy or sell FOMO ticker
7 icp_amount ICP amount of the last transaction
8 buy_sell_op Type of the last transaction (buy or sell)
9 op_user_pid Principal ID of the user who made the last op
10 user_name Username of the user who made the last operation
11 user_avatar Avatar of the user who made the last op
12 swap_timestamp Timestamp of the last swap operation
13 last_create_fomo fomo_idx Index of the last created FOMO project
14 fomo_name Name of the last created FOMO project
15 token_logo Logo URL of the last created FOMO project
16 op_user_pid Principal ID of the creator of the last FOMO
17 user_name Username of the creator of the last FOMO project
18 user_avatar Avatar of the creator of the last FOMO
19 create_time Timestamp when the last FOMO project was created

Endpoint 9: get_god_of_wells

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  () -> (opt FomoProject) query;
  • Request parameters:
  • Response parameters:
Order Name Description
1 fomo_idx Fomo ID
2 name Fomo name
3 ticker Fomo ticker
4 description Fomo description
5 img_url Fomo image URL
6 twitter_link Fomo twitter link
7 telegram_link Fomo telegram link
8 website Fomo official website
9 token_pid Token principal ID
10 pool_pid Pool principal ID
11 fomo_pid Fomo principal ID
12 pool_progress Pool progress
13 pool_progress_done_time Pool progress completion time
14 god_of_wells_progress God of wells progress
15 god_of_wells_time God of wells completion time
16 market_cap Market capitalization
17 create_time Creation timestamp
18 create_user_pid Creator's principal ID
19 reply_count Reply count
20 recently_reply_time Recent reply timestamp
21 recently_bump_time Recent bump timestamp

Endpoint 10: get_points_history_by_index

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  get_points_history_by_index : (nat64, nat64) -> (  vec record { nat64; PointHistory }, ) query;
  • Request parameters:
Order Field Description
1 start Starting index of the query
2 limit Maximum number of items to return
  • Response parameters:
Order Field1 Field2 Description
1 id Unique identifier for the record
2 point_history time Timestamp of the point history
3 idx Index of the point history
4 user_pid User's principal ID
5 op_type Operation type (add or deduct)
6 busi_name Business name
7 amount Amount (can be null if not set)

Endpoint 11: get_user

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  (principal) -> (opt UserProfile) query;
  • Request parameters:
Order Field Description
1 user_pid userid
  • Response parameters:
Order Field1 Field2 Description
1 user_pid User's principal ID
2 user_name User's display name
3 avatar User's avatar
4 last_change_time Timestamp of last change
5 user_points Current user points
6 user_pre_reward_points Previous reward points (can be null)
7 user_all_spend_points Total points spent (can be null)

Endpoint 12: search_fomos

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  (SearchParam) -> (FomoProjectSearchVo) query;
  • Request parameters:
Order Field Description
1 text Search keyword
2 start Starting index of results
3 limit Maximum number of results to return
4 order Sorting order (ascending or descending)
5 sort Sorting criteria (bump order, last reply, reply count, market cap, creation time)
  • Response parameters:
Order Field1 Field2 Description
1 start Starting index of the list
2 end Ending index of the list
3 fomo_vec fomo_idx Fomo index
4 name Fomo name
5 ticker Fomo ticker code
6 description Fomo description
7 img_url Fomo image URL
8 twitter_link Fomo twitter link
9 telegram_link Fomo telegram link
10 website Fomo official website
11 token_pid Fomo token principal ID
12 pool_pid Fomo pool principal ID
13 fomo_pid Fomo fomo principal ID
14 pool_progress Pool progress
15 pool_progress_done_time Pool progress completion time
16 god_of_wells_progress God of wells progress
17 god_of_wells_time God of wells completion time
18 market_cap Market capitalization
19 create_time Creation timestamp
20 create_user_pid Creator's principal ID
21 reply_count Reply count
22 recently_reply_time Recent reply timestamp
23 recently_bump_time Recent bump timestamp

Endpoint 13: set_buy_or_sell

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  set_buy_or_sell : (RecordSignal) -> ();
  • Request parameters:
Order Field Description
1 fomo_idx Fomo index
2 icp_amount Icp amount
3 buy_sell_op Operation type (buy or sell)
4 swap_hash Swap transaction hash

Endpoint 14: spending_points

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  (principal, text) -> ();
  • Request parameters:
Order Field Description
1 user_pid User's principal identifier
2 busi_name Business name

Endpoint 15: topup_points

  • Canister PID: 52g6a-iaaaa-aaaam-acsza-cai
  • Candid:
  topup_points : (nat) -> (Result_2);
  • Request parameters:
Order Field Description
1 points_amount Points amount

Fomowell Project

The Fomowell project contract is generated by the Fomowell launcher and is used to store information such as comments and holding lists.

Endpoint 1: add_comment

  • Canister PID: ${FOMO_PID}
  • Candid:
  add_comment : (CommentsCreate) -> (Result); cycles : () -> (nat64) query;
  • Request parameters:
Order Field1 Field2 Description
1 content Comment content
2 image_url Image URL (can be null if no image)
3 extended key Hashmap, key for extended information
4 value Value for extended information

Endpoint 2: get_comments_by_index

  • Canister PID: ${FOMO_PID}
  • Candid:
  get_comments_by_index : (Page) -> (CommentsVo) query;
  • Request parameters:
Order Field Description
1 start Starting index of pagination
2 limit Maximum number of items per page
  • Response parameters:
Order Field1 Field2 Field3 Description
1 start_idx Starting index of the list
2 end_idx Ending index of the list
3 fomo_vec fomo_idx Fomo index
4 comment_idx Comment index
5 user_pid User's principal ID
6 content Comment content
7 user_star List of stargazer user principal IDs
8 image_url Image URL (can be null)
9 create_time Creation timestamp
10 extended key Hashmap, key for extended information
11 value Value for extended information

Endpoint 3: get_comments_len

  • Canister PID: ${FOMO_PID}
  • Candid:
  get_comments_len : () -> (nat) query;
  • Response parameters:
Order Field Description
1 num Number of Comments

Endpoint 4: get_fomo_info

  • Canister PID: ${FOMO_PID}
  • Candid:
  get_fomo_info : () -> (vec record { text; text }) query;
  • Request parameters:
  • Response parameters: HashMap<String,String>

Endpoint 5: get_top10_holders

  • Canister PID: ${FOMO_PID}
  • Candid:
  get_top10_holders : () -> (vec HolderInfo) query;
  • Request parameters:
  • Response parameters:
Order Field1 Field2 Description
1 account owner User PID
2 subaccount Subaccount identifier
3 amount Amount of holding
4 holder_percent Holding percentage
5 holder_type Holder type description

About

Fomowell canister contract interface introduction

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

0 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

 
 
 

Contributors