Skip to content

Latest commit

 

History

History
101 lines (73 loc) · 8.56 KB

README.md

File metadata and controls

101 lines (73 loc) · 8.56 KB
Raw

TokenScript Examples

This repo contains complete TokenScripts examples which you can use to get started with your own tokens. Natively run on AlphaWallet iOS and Android.

Available content:

  • ENS Tokens
  • EntryTokens
  • Karma: Car Usage Tokens
  • UEFA / FIFA Ticket Tokens
  • EdCon Ticket Tokens
  • ERC20: AAVE, BestRates, Compound, DAI, DDEX, DeFiMoneyMarket, NEST, SAI, USDC, Uniswap, WETH, dForce

tokenscript examples alphawallet tokens

Why use TokenScript?

TokenScripts are signed modules which execute token logic in a secure container. TokenScripts are designed to run on mobile Ethereum Wallets with a native feel and authenticity protection as each TokenScript is signed by a valid authority, thus tampering can be detected.

If you are a token issuer who wants to provide your token as a service to mobile users, or you want third party developers to use your token logic securely, then TokenScript is the perfect framework for you.

How to benefit from this repository

If you have a token and you want to extend its functionality and make it more portable with TokenScript, you can easily get started by copying some of the existing examples and fitting your own logic into them.

For generic ERC20 tokens

Copy the AlphaWallet-Discovery-Token or WETH TokenScript and fit your logic into it. With ERC20 TokenScripts, you can easily display relevant information to the user via an action page or execute transaction logic like making deposits or converting your token.

For ERC20 DeFi tokens

If you have an ERC20 token used in DeFi use cases, we recommend copying one of the compound cTokens and changing it for your own token.

For ERC721 tokens (Non-Fungible Tokens)

Copy the EDCON .xml and .shtml files and change them for your token.

With TokenScripts, you can easily localise your business logic for another language, interpret your token ids via a bitmask without a third party service like OpenSea and display your unique tokens via a layout which will be presented to the mobile user in a native like feel.

Find support 👨‍💻 👩‍💻

Need assistance? Join and let us know issues or feedback at Telegram, Twitter or through our community forums.

Tokenscript Design Weekly Meetings Time: 7PM (Sydney/AEST time), every Thursday.

Add to Calendar:

You can also email us at feedback@alphawallet.com. We would love to hear any of your questions or comments.

Trying TokenScript

For iOS:

  1. Install the latest AlphaWallet iOS App from the App Store.
  2. In the AlphaWallet app, go to Wallet (first tab) and tap the Add/Hide Tokens + button above your tokens
  3. Tap the + button in the top right corner
  4. Paste the Contract Address 0x63cCEF733a093E5Bd773b41C96D3eCE361464942 to make the wallet display the token. The remaining information will auto-fill.
  5. Go to our repository at https://github.com/AlphaWallet/TokenScript-Examples/tree/master/examples/EntryToken and AirDrop the files EntryToken.xml, token.en.shtml, shared.css and enter.en.shtml from your Mac to your iPhone. If you have access to the files in mobile Safari, you can also choose to "Open in AlphaWallet" from the iOS share menu
  6. In the AlphaWallet app, go to Wallet tab and tap on the token "TokenScript Test Tokens (TKS)"
  7. In the AlphaWallet app, check the Settings tab > TokenScript Overrides for the list of TokenScript files. Swipe to delete or tap to share. You can AirDrop the files to another iPhone which has AlphaWallet TestFlight installed

For Android:

  1. Install the latest AlphaWallet Android App from the Play Store.
  2. In the AlphaWallet app, go to Wallet (first tab) and tap the Add/Hide Tokens + button above your tokens
  3. Tap the + button in the top right corner
  4. Paste the Contract Address 0x63cCEF733a093E5Bd773b41C96D3eCE361464942 to make the wallet display the token. The remaining information will auto-fill.
  5. Go to our repository at https://github.com/AlphaWallet/TokenScript-Examples/tree/master/examples/EntryToken, run 'make EntryToken.canonicalized.xml' and drag and drop the file into the sdcard/home/AlphaWallet folder (on your android device).
  6. In the AlphaWallet app, go to Wallet tab and tap on the token "TokenScript Test Tokens (TKS)"
  7. In the AlphaWallet app, check the Settings tab > TokenScript Overrides for the list of TokenScript files. Swipe to delete or tap to share.

For more information about TokenScript and its implementation...

Want to learn what TokenScript is first? Visit our main repository TokenScript, website or visit our community forum.

Contributors

Thank you to all the contributors! You are awesome.


James Sangalli
💻
Weiwu Zhang
💻
James Brown
💻
James Zaki
💻
Hwee-Boon Yar
💻
Victor Zhang
💻

Lucas Toledo
💻
Chintan Rathod
💻
Corey Caplan
💻

License

TokenScript is available under the MIT license. Free for commercial and non-commercial use.