https://github.com/kryptokrauts/sdcworkshop
Rewarding workshop participants at the Social Developers Conference 2024 in $XPR if they successfully execute the task within 30 days.
https://github.com/kryptokrauts/sdcworkshop
smartcontract typescript workshop
Last synced: 6 months ago
JSON representation
Rewarding workshop participants at the Social Developers Conference 2024 in $XPR if they successfully execute the task within 30 days.
- Host: GitHub
- URL: https://github.com/kryptokrauts/sdcworkshop
- Owner: kryptokrauts
- License: apache-2.0
- Created: 2024-02-10T11:45:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T08:48:46.000Z (over 2 years ago)
- Last Synced: 2024-04-21T19:59:46.282Z (about 2 years ago)
- Topics: smartcontract, typescript, workshop
- Language: TypeScript
- Homepage: https://gov.xprnetwork.org/communities/6/proposals/65c25d8e86e4fa65cc393740
- Size: 392 KB
- Stars: 1
- Watchers: 2
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Developing Smart Contracts with TypeScript on XPR Network
This repository contains all contents of the workshop held at the [Social Developers Conference 2024](https://www.eventbrite.com/e/social-developers-conference-2024-tickets-780940292437) organized by the [Social Developers Club](https://socialdevelopersclub.de) in Hamburg, Germany.
The workshop is [sponsored by the XPR Network community](https://gov.xprnetwork.org/communities/6/proposals/65c25d8e86e4fa65cc393740).
## Workshop Contracts
During the workshop, participants will create 3 different [workshop-contracts](./workshop-contracts) to learn and understand core principles for creating & testing Smart Contracts on XPR Network.
For each of these contracts, the required contract files are already provided. The logic is missing and needs to be added by the participants with one single goal:
- Let the predefined tests pass! ;-)
Note:
- The first [hello-world](./workshop-contracts/0-hello-world) contract will be solved and demonstrated by the workshop facilitators to ensure everybody understands what needs to be done.
## XPR Rewards
Everybody who participates in the workshop, will be eligible to get XPR in two ways:
### Redemption of Gift Cards (Immediately, On-Site)
[Gift cards](https://metalx.com/news/virtual-crypto-gift-card) will be created and distributed to all on-site participants.
A paper will be handed out to each particpant that contains 2 QR codes:
- Link to download [WebAuth Wallet](https://wauth.co)
- Link to the Gift Card in order to claim the `3000.0000 XPR`
### Development of Smart Contracts (Homework)
A total amount of `900000.0000 XPR` is reserved to be claimed by workshop participants.
Workshop participants can develop a Smart Contract that must execute a specific logic in order to trigger the [xpr-reward-pool](./reward-contracts/xpr-reward-pool) contract deployed at [sdcworkshop](https://explorer.xprnetwork.org/account/sdcworkshop?loadContract=true&tab=Tables&limit=100) account. An equal share of the XPR reward pool will be distributed to each developer who executes the action on their deployed contract that fullfils the requirement.
The solution needs to be implemented, deployed and executed within 30 days after the workshop. Eligibility to claim ends exactly at unix timestamp `1713180600` (Monday, 15 April 2024, 13:30:00).
Following steps are required in order to allow participants to claim the XPR reward:
1. Developer [registers here](../../issues/new?assignees=marc0olo&labels=registration&projects=&template=register-for-reward.yaml&title=%5BREGISTER%5D%3A+) for the reward task.
1. Workshop facilitator adds the XPR account of the developer to the list of eligible developers in the [xpr-reward-pool](./reward-contracts/xpr-reward-pool) contract deployed at the [sdcworkshop](https://explorer.xprnetwork.org/account/sdcworkshop?loadContract=true&tab=Tables&limit=100) account.
1. Developer forks this repository and implements the missing logic in the [homework](./reward-contracts/homework) contract which is required to claim the share of the reward pool.
1. Developer provides a separate account where the homework-claim-contract which is used to claim the reward will be deployed at.
- It is recommended to set up a separate account via CLI which is used to deploy the contract.
- This can be done by calling the [`setcontract`](https://explorer.xprnetwork.org/account/sdcworkshop?loadContract=true&tab=Actions&limit=100&action=setctacc) action.
1. Developer deploys the homework-contract at the provided account which should be used to claim the reward.
1. Developer performs an action of the homework-contract that will trigger the claim and distribute the XPR to the account of the homework-claim-contract.
#### Note
- Join the [Developer Chat](https://t.me/XPRNetwork/935158) on Telegram to ask questions related to Smart Contract development.
- Unclaimed shares of the reward pool will be returned to the [xprgrants](https://explorer.xprnetwork.org/account/xprgrants) account after 30 days.
#### Example XPR distribution
- 20 developers register
- each developer can claim `900000.0000 XPR / 20 = 45000.0000 XPR`
- 10 developers successfully claim the reward by solving the homework task
- `10 * 45000.0000 XPR = 450000.0000 XPR` will be returned to [xprgrants](https://explorer.xprnetwork.org/account/xprgrants)
## Links & Resources
- [Workshop Slides](.slides/20240316_sc-development-typescript-xpr-network.pdf)
- [WebAuth Wallet](https://wauth.co) - Your Gateway to all dApps
- [XPR Network Development](https://xprnetwork.org)
- [Discussion (Telegram)](https://t.me/XPRNetwork/935158)
- [GitHub](https://github.com/XPRNetwork)
- [Documentation](https://docs.xprnetwork.org/introduction/overview.html)
- [Network Resources](https://resources.xprnetwork.org/storage)
- [Blockchain Explorer](https://explorer.xprnetwork.org/)
- [CLI](https://github.com/XPRNetwork/proton-cli)
- [Blockchain Testing Library (VeRT)](https://github.com/XPRNetwork/vert)
- [TypeScript Smart Contracts](https://github.com/XPRNetwork/ts-smart-contracts)
- Ecosystem dApps
- [BlastPad.io](https://snipverse.com) - Launch & Airdrop of Tokens
- [Governance Dashboard](https://gov.xprnetwork.org) - Proposal Submission & Voting
- [Metal Identity](https://identity.metallicus.com) - KYC process required to access compliance focused dApps
- [Metal Dollar](https://dollar.metalx.com) - Basket of bank reserve-backed stablecoins
- [Metal X](https://metalx.com) - DeFi platform
- [Trading Bot](https://github.com/XPRNetwork/dex-bot)
- [Snipverse](https://snipverse.com) - Social Network
- [Soon.Market](https://soon.market) - NFT marketplace
- [Storex](https://storex.io) - E-Commerce platform