Permalink
Switch branches/tags
activity-pagination-changes avatar-updates bulk-send cancel-bounty-reason cancel_grant contribution_model details_edit details_updates endpoint-fixes feature/vlad/funder-dashboard fix-958 fix-1976-gcbot-notifs fix-2654-mintrange fix/kudos-profile fix/loading-kudos funder-dashboard gas-buffer gh-pages gitcoinbot-refactor grant-listener grant-nav grants-lis grants-listener grants-search grants-updates-details-admin grants_dummy grants grantz-cleanup grantz infinite-expire inno-django-compressor ipfs-always-pin-infura kevin/admin_actions_as_seperate_view kevin/animatejs-POC kevin/blush-makeup kevin/cleanup_dupe_profiles kevin/confirm_before_redeem kevin/dataviz-experiments kevin/dataviz3 kevin/dead_branch kevin/developer-guide-promotion kevin/dupe_profiles kevin/feedback_system kevin/gas-limit-fix kevin/gas_advisories kevin/gas_estimator_on_gas_page kevin/gas_memory_error kevin/gas_prices_auto kevin/gaspricefixkudos kevin/grants-db-sync kevin/grants_updates kevin/handle_unique kevin/how_many_contributors_by_country kevin/kevin-demo kevin/kudos-direct-send-eth-address kevin/kudos-docs kevin/kudos_activity_stream kevin/kudos_limit kevin/labs_nav_treatment kevin/lighted-jack-o-lantern kevin/lookup_txids_for_tips kevin/make-email-sender-less-aggressive-for-tips-kudos kevin/new_bounty_email_keyword_cleanup kevin/new_kudos_form kevin/new_leaderboard_items kevin/no_sumo_if_logged_in kevin/offchain_ui_experiment kevin/orgs_and_profiles kevin/pjs kevin/premium_avatar_items kevin/profilenotfound kevin/programming_langs_in_db kevin/quickfund kevin/receive_email_copy kevin/refactors_kudos_profile kevin/roundup_email_20181019 kevin/search_history kevin/security-docs kevin/send_kudos_to_eth_address kevin/stray_activities kevin/subminer kevin/sync_get_stopgap_fix kevin/tmp-mint-kudos-hotfix kevin/tmp2 kevin/tree_interactivity ks_approve_fix ks_cancel_fixes ks_contract_versioning ks_convert_fix ks_default_image ks_emails ks_fund_miner_fixes ks_miner_fixes ks_save_tx_id ks_sub_network_fix ks_successful_contribution_def kudos-feed kudos-suggestions kudos-v1 kudosfeed logging-updates mark-avatar-be mark-browser-push mark-celery-int mark-integrations mark-livestream-sessions mark-orgs master mig-pref-address-wallets more-kudos new-notifications paginate-api profile-fixes profile_subscriptions rinkeby_fixes roundup-30OCT2018 search-error semaphore-changes stable tooltip-fix
Nothing to show
Find file Copy path
8948c65 Nov 14, 2018
2 contributors

Users who have contributed to this file

@owocki @mbeacom
62 lines (35 sloc) 3.03 KB

Kudos General Documentation

How do I get/test kudos on my local RPC node

This answer assumes you're using docker.

Run these commands

# start from the directory on your local filesystem that contains the gitcoinco web repo
cd ..
git clone git@github.com:gitcoinco/Kudos721Contract.git
cd Kudos721Contract
npm install openzeppelin
cd ../web
bash scripts/mint_test_kudos.bash

The above commands clone the Kudos smart contract, installs the dependencies, deploys the smart contract to ganache, and mints several kudos in the newly minted smart contract.

After the scripts/mint_test_kudos.bash script runs, you will have kudos on your local docker container, via the localhost RPC node

Where is Kudos deployed

Please checkout the github repo for Kudos to see this information.

Can I see the Kudos security audit

Please checkout the github repo for Kudos to see this information.

What is Kudos Direct Send

Kudos Direct Send (KDS) is a direct send of a Kudos ERC 721 NFT from one Ethereum address to another.

Are Kudos unique

Kudos are semi-fungible tokens. Each kudos has a limited production run which is designated in the smart contract in the numClonesAllowed variable..

For example, this kudos has a total of 200 that will ever be in existence.

When a new kudos is minted we create a new Gen 0 Kudos.

That Gen 0 Kudos can then be cloned up to numClonesAllowed times, which will create numClonesAllowed Gen 1 Kudos.

Creating limited production runs of Kudos allows us to manage the unit economics of Kudos. For example, it costs us $20 to pay our illustrator to create a new piece of artwork. Nobody is going to pay $20 for a Kudos NFT, so we instead offer a limited production run of 200 Kudos which are priced at $0.40 each. When that production run sells out, the artist has made gross $40 in revenue, which nets out to $20 in profit.

What is Kudos Indirect Send?

Kudos Indirect Send (KIS) enables Gitcoin users to send a Kudos to any github/gitcoin username. KIS is effectively a proxy account that can hold a Kudos 721 NFT until a recipient (who is authorized by a github username) claims it.

The Kudos Indirect send architecture diagram is available here

When is Kudos Indirect Send used and when is Kudos Direct Send Used?

If a user has set a preferred Ethereum address in their account, KDS will be used.

If not, KIS will be used.

I have a question that's not listed here

Checkout the Kudos FAQ here