Skip to content

Commit

Permalink
Add a high level description of tokenscript, and rename the old one i…
Browse files Browse the repository at this point in the history
…nto tokenscript framework description
  • Loading branch information
Weiwu Zhang committed Jun 24, 2023
1 parent 563a41a commit 2b221b5
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 12 deletions.
3 changes: 2 additions & 1 deletion src/Documents.ditamap
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
<map>
<title>Content TokenScript docs</title>
<topicref href="concept/Tokenization.md" format="mdita"/>
<topicref href="concept/TokenScript.md" format="mdita"/>
<topicref href="index.dita">
<topicref href="TokenScript.dita"/>
<topicref href="concept/TokenScriptFramework.dita"/>
<topicref href="WhatTokenscriptCanDo.dita"/>
<topicref href="defiwithandwithoutts.dita"/>
<topicref href="LivingExamples.dita"/>
Expand Down
25 changes: 25 additions & 0 deletions src/concept/TokenScript.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# TokenScript

TokenScript is a technology that enables Smart Tokens, serving as the building block of the next generation web. It defines the token interface and contains the code logic that drives token adoption, integration, and secure transactions.

## A use-case facing interface for Smart Contracts

TokenScript serves as a new interface for smart contracts. It allows for the extraction of information from smart contracts and presents it in a user-friendly manner. For instance, it can translate contract function outputs into a language the user understands or convert a "True" value into a ticked checkbox.

## Integration with Business Processes

TokenScript can be integrated with business processes. For example, it can describe a shipping token to be able to receive messages. The method of actual communication can be implemented by other layers of blockchain technology like a message queue or even a distributed message queue.

## Enabling Market Participation

Working on top of smart contracts, TokenScript connects the tokens to the use-cases where they are presented, indexed, traded, or function to enable use-cases. It provides both the deliverable and the payment side tokens to plug into the market.

## Scalability

To scale, the knowledge about the token (TokenScript) must be detached from the access to the token. It can work in the middle for the making of such tokens.

## Security

TokenScript is designed to separate token rendering code, and transaction generating code and package them into its container, signed by a party that the user is likely to trust.

In conclusion, TokenScript is a crucial technology that enables the creation and operation of smart tokens. It serves as the building block for the next generation web, defining the token interface and containing the code logic that drives token adoption, integration, and secure transactions. It relies on the token script engine in next-generation browsers and smart layers to operate these codes, paving the way for a more integrated, decentralized, and user-centric digital world.
21 changes: 10 additions & 11 deletions src/TokenScript.dita → src/concept/TokenScriptFramework.dita
Original file line number Diff line number Diff line change
@@ -1,39 +1,38 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
<concept id="topic_nlj_qhg_nmb">
<title>TokenScript Overview</title>
<title>TokenScript Framework</title>
<conbody>
<p dir="ltr" id="docs-internal-guid-e0588b59-7fff-f9c6-08d4-576a2c544c53">TokenScript is a
Tokenisation framework. It wraps HTML, JavaScript and XML to express Token
functionalities and make them deployable in the wallet and on websites. With
TokenScript, any token can unlock its customized mini dapp. </p>
<p>TokenScript creates a <xref href="TokenLayer.dita"/>: A <xref href="DataDriven.dita"/>,
and <xref href="ContextBased.dita"/> layer between the blockchain and the user. On this
functionalities and make them deployable in the wallet and on websites.</p>
<p>TokenScript creates a <xref href="../TokenLayer.dita"/>: A <xref href="../DataDriven.dita"/>,
and <xref href="../ContextBased.dita"/> layer between the blockchain and the user. On this
layer, token are the basic unit to structure the interaction between users and
blockchains.</p>
<p dir="ltr">TokenScript consists of two parts:</p>
<ul id="ul_omt_14t_ymb">
<li dir="ltr">TokenScript Engine, which works in the user's wallet, on the web or in a
browser plugin. The TokenScript Engine provides the runtime environment for tokens
to be used on 3rd party websites.</li>
<li dir="ltr">The<xref href="TokenScript-Component.dita"/> wraps XML, HTML and
<li dir="ltr">The<xref href="../TokenScript-Component.dita"/> wraps XML, HTML and
JavaScript and is issued and signed by the corresponding Token Issuer. It can be
imported by any service or device which implemented TokenScript Engine. The file
provides additional token information, structures the token UX in the wallets, and
appends rules, data modules, transaction security measurements and much more. </li>
</ul>
<p dir="ltr">TokenScript files are <xref href="Signing.dita">signed by the creator of the
<p dir="ltr">TokenScript files are <xref href="../Signing.dita">signed by the creator of the
token smart contract or a trusted source</xref> with a public key. Wallets and dApps
can import and verify the files and make sure users only get authorized TokenScripts
from trusted sources.</p>
<p dir="ltr">TokenScript is blockchain agnostic. The main focus of our development is based
on Ethereum token. But it can be adopted to other blockchains and even combine token and
interactions of different blockchains. TokenScript is not a standard for token, but
<xref href="ts-vs-token-standards.dita">a standard for a Token Layer</xref>, which
<xref href="../ts-vs-token-standards.dita">a standard for a Token Layer</xref>, which
enables wallets and apps and websites to work with any non-standardized token as easy as
with ERC token.</p>
<p dir="ltr">This guide will educate you about the<xref href="BasicConcepts.dita"> basic
concepts of TokenScript</xref> and the <xref href="Deploy.dita">deployment</xref> of
<p dir="ltr">This guide will educate you about the<xref href="../BasicConcepts.dita"> basic
concepts of TokenScript</xref> and the <xref href="../Deploy.dita">deployment</xref> of
a TokenScript. </p>
<section>
<title>TokenScript benefits </title>
Expand Down Expand Up @@ -113,7 +112,7 @@
<p dir="ltr">TokenScript enables token issuers to leave the restrictions of smart
contracts behind. It allows to add a lot of information, even image files or API
lookups to a token, and design a set of business rules and interaction logics for
it, including <xref href="concept/Attestation.md" format="mdita">attestations</xref> and structured
it, including <xref href="../concept/Attestation.md" format="mdita">attestations</xref> and structured
interactions with other tokens. </p>
<p dir="ltr">Moreover, with TokenScript token issuers can easily and securely update the
token rules.</p>
Expand Down

0 comments on commit 2b221b5

Please sign in to comment.