Logo

githoney-badges

UnofficialPreliminary, reverse-engineered version published by the tx3 team for testing and exploration. It is not endorsed by the original protocol authors. Do not use in mainnet. • v0.1.0

About this Protocol

CIP-68 contributor and maintainer badges for GitHoney on Cardano: mint, update metadata, transfer, and reclaim

Parties

The participants involved in this protocol's transactions.

distributorWallet that holds the circulating fungible badge tokens.
recipientRecipient of a fungible badge token transferred by `pay_badges_to`.
registryBadge validator address that holds each badge's CIP-68 reference NFT (metadata).
githoneyGitHoney operator wallet that mints, updates, and reclaims badges.

Environment

Configuration values required to execute this protocol's transactions.

badge_policy_idMinting policy id of the badge tokens./$defs/Bytes
badge_policy_scriptBadge minting-policy bytes./$defs/Bytes
badge_policy_script_versionPlutus version of the badge minting policy.integer
badges_scriptBadge spend validator bytes./$defs/Bytes
badges_script_versionPlutus version of the badge spend validator.integer
settings_refPublished GitHoney settings UTxO, referenced by badge spends for protocol authorization./$defs/UtxoRef

Transactions

The transactions defined in this protocol, with their parameters, inputs, and outputs.

mint_badge

Mint a CIP-68 badge pair: the reference NFT (carrying metadata) to the badge script, and the fungible badge tokens to the Distributor wallet.

Diagram

mint_badgedescriptiondescription_valueft_badge_amountft_badge_namelogologo_valuem_versionnamename_valueref_nft_asset_nameutxo_ref distributor githoney registry funds tokens change new_badge

Parameters

descriptionBytesMetadata key bytes for the "description" entry.
description_valueBytesMetadata value stored under the "description" key.
ft_badge_amountIntNumber of fungible badge tokens to mint.
ft_badge_nameBytesAsset name of the fungible badge token.
logoBytesMetadata key bytes for the "logo" entry.
logo_valueBytesMetadata value stored under the "logo" key.
m_versionIntBadge metadata version written into the `BadgeDatum`.
nameBytesMetadata key bytes for the "name" entry.
name_valueBytesMetadata value stored under the "name" key.
ref_nft_asset_nameBytesAsset name of the CIP-68 reference NFT.
utxo_refUtxoRefGitHoney wallet UTxO consumed to fund and back the mint.

Inputs

funds—wallet

Outputs

registryyesno
distributornono
githoneynono

update_badge

Rewrite a badge's on-chain metadata datum, keeping the reference NFT in place.

Diagram

update_badgebadge_utxo_refdescriptiondescription_valuelogologo_valuem_versionnamename_value githoney githoney registry funds badge change updated_badge

Parameters

badge_utxo_refUtxoRefThe badge reference-NFT UTxO whose metadata is being updated.
descriptionBytesMetadata key bytes for the "description" entry.
description_valueBytesNew metadata value for the "description" key.
logoBytesMetadata key bytes for the "logo" entry.
logo_valueBytesNew metadata value for the "logo" key.
m_versionIntUpdated badge metadata version.
nameBytesMetadata key bytes for the "name" entry.
name_valueBytesNew metadata value for the "name" key.

Inputs

fundsgithoneywallet
badge—script

Outputs

registryyesno
githoneynono

pay_badges_to

Transfer a single fungible badge token from the Distributor wallet to a recipient.

Diagram

pay_badges_tobadge_namebadge_policy distributor distributor recipient tokens funds change payment

Parameters

badge_nameBytesAsset name of the badge token to transfer.
badge_policyBytesPolicy id of the badge token to transfer.

Inputs

tokensdistributorwallet
fundsdistributorwallet

Outputs

recipientnono
distributornono

collect_badge_utxos

Reclaim a UTxO sitting at the badge script back into the GitHoney wallet.

Diagram

collect_badge_utxosutxo_to_collect githoney githoney funds stray change

Parameters

utxo_to_collectUtxoRefThe badge-script UTxO to collect.

Inputs

stray—script
fundsgithoneywallet

Outputs

githoneynono

Profiles

Pre-configured sets of environment and party values for different deployment targets.

preprod
badge_policy_id0xf2142e5b751cdb834ed75a5215f47759d0ddc37937b01a4cb97178c1env
badge_policy_script0x5906300101003229800aba4aba2aba1aba0aab9faab9eaab9dab9cab9a9bae0024888888888a60022a660069212c6578706563742073657474696e67735f646174756d3a2053657474696e6773446174756d203d20646174756d00168a99801a492765787065637420496e6c696e65446174756d28646174756d293a20446174756d203d206461746100168a99801a4928657870656374205b7265665f696e7075745d203d2074782e7265666572656e63655f696e70757473001648896600264653001300d00198069807000cdc3a4005300d00248889660026004601a6ea800e26645300130130029809980a0014c04cc040dd5180998081baa323322598008014032264b300130180038acc0066002601064b300130093014375400314800226eb4c060c054dd5000a02432598009804980a1baa0018a6103d87a8000899198008009bab30193016375400444b30010018a6103d87a8000899192cc004cdc8a450b73657474696e67734e4654000018acc004cdc7a4410b73657474696e67734e465400001899ba548000cc06cc0640092f5c114c0103d87a80004059133004004301d00340586eb8c05c004c068005018202432330010013756600a602a6ea8c014c054dd5001112cc004006298103d87a8000899192cc004cdc880a000c56600266e3c050006266e9520003301a30180024bd7045300103d87a80004055133004004301c00340546eb8c058004c064005017528528a0228a9980924813f54686572652073686f756c642062652065786163746c79206f6e652073657474696e6773204e465420696e20746865207265666572656e636520696e70757400168992cc0040062b30013370e9002180a1baa0018992cc00400602113259800980d8014566002003132598009804980b9baa0028992cc00400602913259800800c4c9660020030168992cc00400602f01780bc4cc89660020030198992cc00400603501a80d44c96600260480071598009808980f9baa0078992cc00400603913259800800c4c96600200301e8992cc0040062b300130280028cc00400e264b300130160018992cc00400604313259800800c566002605600513259800980c800c4c9660020030248992cc0040062b3001302e0028cc004006027025406102540ad025812c09604a8178c0b000502a18141baa0028acc004c070006264b300100181244c966002003025812c09626644b3001001813c4c96600200302881440a226644b300100181544c96600200302b815c0ae264b3001303500380d40b10321bad001815a06a303200140c06eb4004c0c400a0508190c0bc00502d1bad001302e002812a05e302c00140a860506ea800a046812902518131baa0018112050811408a04502240b060520028138c094dd50014566002603200315980098129baa0028074081026408102220443023375400301f404901f409501f80fc07e03e8148c0980050241813001407603b01d80ea04e3024001408860406ea801e03680ea0368108dd6800c0690241810800a03e375a00260400050174084603c00280e0c07800a02b01580ac05501f180e000a0343018375400501340542003012809404a02480e202280c0c064005017180a9baa001807a024807c03e01f00f4068602e6030603060286ea8c010c050dd5000a022806a02a301600240506eb0c004c044dd5002111192cc004c018006264b3001001801c4c966002003004802401200913259800980e001c01a00a80c8dd7000a0383019001405c602a6ea80122b300130090018992cc00400600713259800800c01200900480244c9660026038007006802a032375c00280e0c064005017180a9baa0048012024404860266ea800c8c050c0540066eb0c04cc050c050c050c050c050c050c050c050c040dd5001a4444b300130053013375400513232330010010032259800800c528456600266e3cdd7180d000801c528c4cc008008c06c0050142030375c602e60286ea800a2a660249212d65787065637420566572696669636174696f6e4b657928766b29203d20766572696669636174696f6e5f6b657900164044300e37540066e1d20008b2016180680098041baa00e8a4d153300649011856616c696461746f722072657475726e65642066616c7365001365640142611e581c62a2b23ee7465865ed9df516f0a2c030574fe25a7f226a7e88c72ae40001env
badge_policy_script_version3env
badges_script0x5906300101003229800aba4aba2aba1aba0aab9faab9eaab9dab9cab9a9bae0024888888888a60022a660069212c6578706563742073657474696e67735f646174756d3a2053657474696e6773446174756d203d20646174756d00168a99801a492765787065637420496e6c696e65446174756d28646174756d293a20446174756d203d206461746100168a99801a4928657870656374205b7265665f696e7075745d203d2074782e7265666572656e63655f696e70757473001648896600264653001300d00198069807000cdc3a4005300d00248889660026004601a6ea800e26645300130130029809980a0014c04cc040dd5180998081baa323322598008014032264b300130180038acc0066002601064b300130093014375400314800226eb4c060c054dd5000a02432598009804980a1baa0018a6103d87a8000899198008009bab30193016375400444b30010018a6103d87a8000899192cc004cdc8a450b73657474696e67734e4654000018acc004cdc7a4410b73657474696e67734e465400001899ba548000cc06cc0640092f5c114c0103d87a80004059133004004301d00340586eb8c05c004c068005018202432330010013756600a602a6ea8c014c054dd5001112cc004006298103d87a8000899192cc004cdc880a000c56600266e3c050006266e9520003301a30180024bd7045300103d87a80004055133004004301c00340546eb8c058004c064005017528528a0228a9980924813f54686572652073686f756c642062652065786163746c79206f6e652073657474696e6773204e465420696e20746865207265666572656e636520696e70757400168992cc0040062b30013370e9002180a1baa0018992cc00400602113259800980d8014566002003132598009804980b9baa0028992cc00400602913259800800c4c9660020030168992cc00400602f01780bc4cc89660020030198992cc00400603501a80d44c96600260480071598009808980f9baa0078992cc00400603913259800800c4c96600200301e8992cc0040062b300130280028cc00400e264b300130160018992cc00400604313259800800c566002605600513259800980c800c4c9660020030248992cc0040062b3001302e0028cc004006027025406102540ad025812c09604a8178c0b000502a18141baa0028acc004c070006264b300100181244c966002003025812c09626644b3001001813c4c96600200302881440a226644b300100181544c96600200302b815c0ae264b3001303500380d40b10321bad001815a06a303200140c06eb4004c0c400a0508190c0bc00502d1bad001302e002812a05e302c00140a860506ea800a046812902518131baa0018112050811408a04502240b060520028138c094dd50014566002603200315980098129baa0028074081026408102220443023375400301f404901f409501f80fc07e03e8148c0980050241813001407603b01d80ea04e3024001408860406ea801e03680ea0368108dd6800c0690241810800a03e375a00260400050174084603c00280e0c07800a02b01580ac05501f180e000a0343018375400501340542003012809404a02480e202280c0c064005017180a9baa001807a024807c03e01f00f4068602e6030603060286ea8c010c050dd5000a022806a02a301600240506eb0c004c044dd5002111192cc004c018006264b3001001801c4c966002003004802401200913259800980e001c01a00a80c8dd7000a0383019001405c602a6ea80122b300130090018992cc00400600713259800800c01200900480244c9660026038007006802a032375c00280e0c064005017180a9baa0048012024404860266ea800c8c050c0540066eb0c04cc050c050c050c050c050c050c050c050c040dd5001a4444b300130053013375400513232330010010032259800800c528456600266e3cdd7180d000801c528c4cc008008c06c0050142030375c602e60286ea800a2a660249212d65787065637420566572696669636174696f6e4b657928766b29203d20766572696669636174696f6e5f6b657900164044300e37540066e1d20008b2016180680098041baa00e8a4d153300649011856616c696461746f722072657475726e65642066616c7365001365640142611e581c62a2b23ee7465865ed9df516f0a2c030574fe25a7f226a7e88c72ae40001env
badges_script_version3env
settings_ref9edc3087527514724b297475f84a8ab316faab1950ce1882715cf4bf88b20b64#0env
Back to all Protocols