Skip to content
This repository has been archived by the owner on Jul 8, 2024. It is now read-only.

Latest commit

 

History

History
127 lines (85 loc) · 9.15 KB

README.md

File metadata and controls

127 lines (85 loc) · 9.15 KB
Raw

Kitty Items API

The Kitty Items API is a RESTful API built with express that sends transactions to Flow using the Flow JS SDK. It contains endpoints for both the kitty-items & storefront services to read & write data to both the Flow blockchain and a SQL database.

Getting Started

Here are some commands to help you get started with initializing and executing on the Kitty Items API. See Kitty Items Service and Storefront Service for more details on these endpoints.

Setup

Run the commands below to initialize the minter account.

  • /v1/kitty-items/setup
curl --request POST \
--url http://localhost:3000/v1/kitty-items/setup \
--header 'Content-Type: application/json'
  • /v1/market/setup
curl --request POST \
--url http://localhost:3000/v1/market/setup \
--header 'Content-Type: application/json'

Minting

Run the commands below to mint new items and list them for sale.

  • /v1/kitty-items/mint
curl --request POST \
--url http://localhost:3000/v1/kitty-items/mint \
--header 'Content-Type: application/json' \
--data '{
    "recipient": "'$ADMIN_ADDRESS'",
    "kind": 1
    }'
  • /v1/market/sell
curl --request POST \
--url http://localhost:3000/v1/market/sell \
--header 'Content-Type: application/json' \
--data '{
    "itemID": 0,
    "price": 7.9
    }'

Services

The Kitty Items API contains four main services. These services synchronize data between the blockchain and the SQL database, and also provide API endpoints consumed by the Kitty Items client-side application.

Flow Service

This service contains functions that interact with the Flow blockchain using the FCL JS library. While it has no exposed endpoints, its methods used to read, write and authorize data on the chain are used extensively by its sister services and workers.

Notable functions:

  • sendTx(): Takes a Cadence transaction as an arguement and sends it to write data into the Flow blockchain.
  • executeScript(): Takes a Cadence script as an arguement and executes it to read data from the Flow blockchain.
  • getLatestBlockHeight(): Gets the most recent block from the Flow blockchain.
  • authorizeMinter(): Returns an asynchronous method to authorize an account to mint Kitty Items.

Block Cursor Service

This service watches for state-changing events emitted by the Kitty Items contract and updates the SQL database accordingly.

Notable functions:

  • findOrCreateLatestBlockCursor(): Queries the block_cursor table for the the last block check by the listing handler worker. If no row is found then insert a record with our current latest block height.
  • updateBlockCursorById(): Updates the row with the latest block height that has been checked for events.

Kitty Items Service

This service contains functions that utilize the Flow Service to send Cadence transactions and scripts that fetch and update Kitty Items data.

You can also run the transactions and scripts manually using the Flow CLI.

Exposed Endpoints:

  • POST /v1/kitty-items/setup [DEPRECATED]: Sets up account with a resource that stores Kitty Items in the admin minter account. The startup script directly sends the setup Cadence transaction instead of using this endpoint. Calls setup_account.cdc

  • POST /v1/kitty-items/mint [DEPRECATED]: Mint a Kitty Item and send it to a recipient account. Calls mint_kitty_item.cdc

  • POST /v1/kitty-items/mint-and-list: Mint a Kitty Item and immediately list it for sale. Called by the admin account to mint and sell new items. Calls mint_and_list_kitty_item.cdc

  • POST /v1/kitty-items/transfer: Sends a Kitty Item from the admin account to a recipient account. Calls transfer_kitty_item.cdc

  • GET /v1/kitty-items/collection/:account: Fetches a collection of Kitty Item IDs for an account. Calls get_collection_ids.cdc

  • GET /v1/kitty-items/item/:address/:itemID: Fetches a specific Kitty Item for an account. Calls get_kitty_item.cdc

  • GET /v1/kitty-items/supply: Fetches the total supply of Kitty Items. Calls get_kitty_items_supply.cdc.

Storefront Service

This service contains functions that read and write Kitty Items listing data to both the Flow blockchain as well as the SQL database. These functions are exposed through endpoints to allow users to purchase and list their Kitty Items on the marketplace. Similar to the Kitty Items service, the Cadence scripts/transactions can be called in the Flow-cli and directly read/write to the Flow blockchain.

Exposed Endpoints:

  • POST /v1/market/setup [DEPRECATED]: Sets up account with a resource that stores listings for Kitty Items in the admin account. The startup script directly sends the setup Cadence transaction instead of using this endpoint. Calls setup_account.cdc

  • POST /v1/market/buy: Takes payment and transfers KittyItem from seller account to recipient. Calls purchase_listing.cdc

  • POST /v1/market/sell: Creates Kitty Items listing on the Flow blockchain. Kitty Items that associated to listings are not removed from the seller's account until item is purchased. Calls create_listing.cdc

  • GET /v1/market/collection/:account: Fetches all the listings created by the account. Returns an array of listing_resource_ids. Calls get_listings.cdc

  • GET /v1/market/collection/:account/:item: Fetches a specific listing for account and itemID. Calls get_listing.cdc

  • GET /v1/market/latest: Queries the listings table with different parameters to fetch an array of listings in order of recency. Returns an array of listings.

  • GET /v1/market/:id: Queries the listings table to fetch a specific itemID. Returns a specific listing.

Database

I thought Kitty Items were NFTs that exist on the blockchain. Why do we need a database?

While a DB is not necessary to purchase, sell, and mint Kitty Items, it greatly reduces the number of queries executed against the blockchain, creating a much more performant app! Since Kitty Items listings are tied to the account that owns the Kitty Item up for sale, we would need to query the blockchain for all accounts that have created Kitty Item listings in order to create a collection of listings we could call a marketplace. Saving the listings in a database and updating the table when listings are created and deleted greatly reduces the number of calls needed to fetch accurate listing data.

Tables

  • listings: This table is used to store all listings on the marketplace and storefront. The difference between Storefront and Marketplace is that Kitty Items listed by users are considered Marketplace listings and the items listed by the admin account and considered Storefront listings.
  • block_cursor: This table is used to record the last visited block on the Flow blockain. Workers use and update this row when checking the blockchain for listing events.

Workers

In order to ensure the listing data in the database is consistent with the data on the blockchain, we must run a event handler worker that periodically checks windows of blocks on the Flow blockchain for listing events. When we come across a listing event, the handler will run a query to update the database to be consistant with the blockchain.

  • base_event_handler: This is an abstract class contains the logic to poll the blockchain for events we want to action on. The polling function first queries the blockchain and database to create a block search window. Then it queries the blockchain again for relevant events within the computed search window. Once the search is complete, the last seen block height is recorded in the database and the method recursively calls itself to continue polling.

  • listing_handler.ts: This handler extends the base_event_handler and defines the listing events we want to check for. It also contains the onEvent() business logic to be ran when a listing event is found.