Extra Docs for Blockchain Events
• Written by Josh Wolff
Context Required Depending on the Event Group
The list below$$ describes which fields in the primary_event_context
dictionary are required depending on the type of NFT event.
nft_list
- owner
- price
nft_de_list
- owner
nft_buy
- owner
- buyer
- price
nft_make_offer
- buyer
- price
nft_accept_offer
- owner
- buyer
- price
nft_cancel_offer
- buyer
nft_update_price
- owner
- price
nft_amm_sell
- owner
- buyer
- price
nft_amm_buy
- owner
- buyer
- price
nft_amm_deposit
- owner
nft_amm_withdraw
- owner
nft_amm_accept_offer
- owner
- buyer
- price
nft_edition_list
- owner
nft_edition_de_list
- owner
nft_mint_from_edition
- buyer
- new_mint
- new_mint_owner
- edition_owner
- edition_mint
nft_raffle_list
- owner
- price
- n_tickets
- ticket_price
- end_timestamp
nft_raffle_de_list
- owner
nft_raffle_claim
- buyer
- price
nft_update_raffle
- owner
nft_buy_raffle_ticket
- buyer
- price
nft_option_expired
- owner
nft_option_exercised
- owner
- buyer
- strike_price
nft_cancel_option_offer
- owner
nft_accept_call_offer
- owner
- buyer
nft_offer_call
- owner
- premium
- strike_price
- start_timestamp
- end_timestamp
nft_accept_put_offer
- owner
- buyer
nft_offer_put
- owner
- premium
- strike_price
- start_timestamp
- end_timestamp
nft_create_auction
- owner
- price
nft_update_auction
- owner
- price
nft_bid_auction
- buyer
- price
nft_cancel_auction_bid
- buyer
nft_redeem_auction
- owner
- buyer
- price
nft_cancel_auction
- owner
nft_create_airdrop
- owner
nft_mint_from_airdrop
- new_mint_owner
- new_mint
- edition_owner
- edition_mint
nft_airdrop_mint
- new_mint_owner
- new_mint
- edition_owner
- edition_mint
nft_make_loan_offer
- buyer
- price
nft_cancel_loan_offer
- buyer
nft_loan_list
- owner
- price
nft_loan_de_list
- owner
nft_accept_loan_listing
- owner
- creditor
- price
nft_default_on_loan
- creditor
nft_pay_back_loan
- owner
- creditor
- price
nft_rent_nft
- owner
- buyer
nft_return_rented_nft
- owner
- buyer
nft_list_for_rent
- owner
- price
nft_de_list_for_rent
- owner
nft_p2p_trade_list
- owner
nft_p2p_trade_de_list
- owner
nft_p2p_update_trade
- owner
nft_p2p_complete_trade
- owner
- sender
- receiver
nft_p2p_trade_make_offer
- buyer
nft_p2p_trade_cancel_offer
- buyer
nft_stash_nft
- owner
nft_unstash_nft
- owner
- receiver
nft_fractionalize_nft
nft_stake_nft
- owner
nft_unstake_nft
- owner
nft_transfer_nft
- owner
- sender
- receiver
nft_burn_nft
- owner
nft_mint_nft
- price
- buyer
nft_mint_master_edition
- owner
nft_metadata_update
- n/a
nft_unknown
- n/a
ata_close_account
- n/a
ata_create_account
- n/a
set_authority
- n/a
sol_escrow_transfer
- n/a
validation
- n/a
preparation
- n/a
multi_sig_transaction
- n/a
Event Group Descriptions
This list describes succintly to what each event refers.
nft_list
- The listing of an NFT for sale, such as on MagicEden.
nft_de_list
- The removal of a listing.
nft_buy
- The purchase of an NFT for sale.
nft_make_offer
- An offer made on an NFT, which may or may not be listed for sale.
nft_accept_offer
- An acceptance of an existing offer made on an NFT, which may or may not have been listed for sale.
nft_cancel_offer
- The cancellation of an offer previously made.
nft_update_price
- The owner updated a price of a listed NFT.
nft_amm_sell
- The NFT is sold to an AMM. The NFT is thereafter held in the AMM liquidity pool
nft_amm_buy
- The NFT is purchased from an AMM liquidity pool
nft_amm_deposit
- The NFT is deposited into the AMM liquidity pool by the liquidity pool owner. No purchase is made here.
nft_amm_withdraw
- The NFT is withdrawn from the AMM liquidity pool by the liquidity pool owner. No purchase is made here.
nft_amm_accept_offer
- The NFT is sold directly to another user who made a bid on the collection via the AMM contract, rather than being sold to the AMM liquidity pool.
nft_edition_list
- An edition NFT is listed. The edition itself is not for sale, but copies of it can be minted from the edition.
nft_edition_de_list
- The edition NFT was de-listed.
nft_mint_from_edition
- An NFT copy was minted from the edition.
nft_raffle_list
- An NFT was listed for a raffle
nft_raffle_de_list
- An NFT raffle was canceled
nft_raffle_claim
- The winner of the raffle claimed the NFT prize
nft_update_raffle
- The raffle paramters were updated
nft_option_expired
- The NFT option was expired and the NFT was returned the original owner / contract maker.
nft_option_exercised
- The NFT option was exercised by the purchaser
nft_cancel_option_offer
- The NFT option offer was canceled
nft_accept_call_offer
- The NFT call option offer was accepted
nft_offer_call
- An options contract for the NFT was created, and the NFT was moved to escrow
nft_accept_put_offer
- The NFT put option offer was accepted
nft_offer_put
- An options contract for the NFT was created, and the NFT was moved to escrow
nft_create_auction
- The NFT was put up for auction.
nft_bid_auction
- A bid was made on an NFT listed for auction.
nft_cancel_auction_bid
- A bid was canceled
nft_redeem_auction
- The final sale price of the NFT was accepted, or the auction was closed and the NFT sold for the highest price.
nft_cancel_auction
- The auction was canceled.
nft_create_airdrop
- An airdrop NFT was created. This is a contract that will be used to send NFTs to users
nft_mint_from_airdrop
- An NFT was minted from a collection via an airdrop contract
nft_airdrop_mint
- An NFT edition is being airdropped
nft_make_loan_offer
- A SOL/other token loan offer was made by a user
nft_cancel_loan_offer
- A SOL/other token loan offer was canceled by a user
nft_loan_list
- An NFT was offered as collateral for a loan
nft_loan_de_list
- An NFT was removed from escrow where it was previously held for a loan listing
nft_accept_loan_listing
- The loan was accepted by a
creditor
.
- The loan was accepted by a
nft_default_on_loan
- The previous owner of the NFT did not pay back the loan in time and so defaulted. The NFT was then transferred to the
creditor
.
- The previous owner of the NFT did not pay back the loan in time and so defaulted. The NFT was then transferred to the
nft_pay_back_loan
- The owner paid back the loan and received the NFT they put up as collateral in return.
nft_rent_nft
- The NFT was rented to the
renter
.
- The NFT was rented to the
nft_return_rented_nft
- The NFT was returned to the owner by the renter.
nft_list_for_rent
- The NFT was listed for rent.
nft_de_list_for_rent
- The rental listing was removed.
nft_p2p_trade_list
- The NFT was moved to escrow as part of a P2P trade offering
nft_p2p_trade_de_list
- The NFT was removed from escrow
nft_p2p_update_trade
- A P2P trade where the NFT is held in escrow was updated
nft_p2p_complete_trade
- A P2P trade was completed and the NFT was transferred to a new owner
nft_p2p_trade_make_offer
- The NFT owner received a P2P trade offer
nft_p2p_trade_cancel_offer
- A P2P trade offer previously made to the NFT owner was canceled
nft_stash_nft
- The NFT was stashed in a vault. This is different from
staking
because instaking
you receive a reward for the lock-up. Instashing
, you do not receive a reward.
- The NFT was stashed in a vault. This is different from
nft_unstash_nft
- The NFT was unstashed.
nft_stake_nft
- The NFT was staked.
nft_unstake_nft
- The NFT was unstaked.
nft_transfer_nft
- The NFT was transferred to a new owner.
nft_burn_nft
- The NFT was burned.
nft_mint_nft
- The NFT was created.
nft_mint_master_edition
- A master edition for the NFT was created.
nft_metadata_update
- The metadata of the NFT was updated.
nft_unknown
- An unknown event involving the NFT occurred.
ata_close_account
- An associated token account was closed.
ata_create_account
- An associated token account was created.
set_authority
- The authority for the associated token account of the NFT was changed.
sol_escrow_transfer
- SOL was transferred from/to escrow.
validation
- A validation, intermediate step before a more important transaction, was made.
preparation
- A preparation, intermediate step before a more important transaction, was made.
multi_sig_transaction
- A transaction was signed with a multi-sig. We try to decode the underlying transaction and return this instead. If we are unable, we return
multi_sig_transaction
.
- A transaction was signed with a multi-sig. We try to decode the underlying transaction and return this instead. If we are unable, we return
Account State Descriptions
- loaning
- The NFT is being held in escrow as collateral for a loan.
- loan_listing
- The NFT is held in escrow or frozen as part of a loan offering.
- listing
- The NFT is listed for sale.
- amm_listing
- The NFT is held in an AMM liquidity pool
- p2p_listing
- The NFT is held in escrow for a proposal for a P2P trade.
- options_listing
- The NFT is held in escrow as an offer for a PUT/CALL contract
- options_trading
- The NFT is held in escrow for an active PUT/CALL contract
- listing_for_rent
- The NFT is lised for rent.
- renting
- The NFT is being rented by a user.
- auctioning
- The NFT is being auctioned.
- airdropping
- The NFT is being airdropped via an airdropping contract to users
- staking
- The NFT is staked in return for a reward.
- stashing
- The NFT is being stashed.
- raffling
- The NFT is being raffled (users purchase tickets for a chance to win the NFT)
- holding
- The NFT is held in the wallet.
- burned
- The NFT was permanently burned.
Written by Josh Wolff