Skip to content

Commit

Permalink
Rename scrypt to sCrypt.
Browse files Browse the repository at this point in the history
Also fix 1 typo
  • Loading branch information
xhliu committed Aug 6, 2019
1 parent c0a4234 commit b3f3966
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

# -- Project information -----------------------------------------------------

project = 'Scrypt'
project = 'sCrypt'
copyright = '2019, Xiaohui Liu'
author = 'Xiaohui Liu'

Expand Down
4 changes: 2 additions & 2 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Functions

User-Defined Functions
======================
Scrypt enables developers to define their own functions as examplified below:
sCrypt enables developers to define their own functions as examplified below:

.. code-block:: solidity
Expand All @@ -27,7 +27,7 @@ Recursion is disallowed. A function cannot call itself in its body.

Library Functions
=================
The following functions come with Scrypt and are availabe globally.
The following functions come with sCrypt and are availabe globally.

Math
----
Expand Down
10 changes: 5 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
=============================
The Scrypt Language Reference
The sCrypt Language Reference
=============================

Scrypt (pronounced “ess crypt”) is a high-level smart contract language for Bitcoin SV.
sCrypt (pronounced “ess crypt”) is a high-level smart contract language for Bitcoin SV.
Bitcoin supports smart contract with its Forth-like stack based Script language.
However writing smart contract in native Script is cumbersome and error-prone.
It quickly becomes intractable when the contract size and complexity grow.

Script is designed to facilitate writing smart contract running on chain.

* It is easy to learn. Syntactically, Scrypt is similar to Solidity, making it easier to be adopted by existing smart contract developers. However, the resemblance is only superficial, since Scrypt is compiled into Bitcoin Script by the underlying compiler, instead of EVM bytecode.
* It is easy to learn. Syntactically, sCrypt is similar to Solidity, making it easier to be adopted by existing smart contract developers. However, the resemblance is only superficial, since sCrypt is compiled into Bitcoin Script by the underlying compiler, instead of EVM bytecode.
* It is statically typed. Type checking can help detect many errors at compile time.
* It comes with a full-fledged IDE, including editor, compiler, and debugger. The first version is web based, no installation required to start playing immediately.


.. Warning:: Scrypt is still in experimental phase and not ready for production use.
.. Warning:: sCrypt is still in experimental phase and not ready for production use.

.. toctree::
:maxdepth: 2
Expand All @@ -32,7 +32,7 @@ Script is designed to facilitate writing smart contract running on chain.

.. toctree::
:maxdepth: 1
:caption: Scrypt by Example
:caption: sCrypt by Example

p2pkh
rpuzzle
Expand Down
2 changes: 1 addition & 1 deletion docs/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ A contract consists of two parts: locking script and unlocking script.
Constructor
===========
Each contract has one and only one constructor. It is where contract member variables are initantiated.
Each contract has one and only one constructor. It is where contract member variables are initialized.
For example, it can initialize the public key hash of a P2PHK contract, or the hash of a secret in a hash puzzle contract.

require
Expand Down
6 changes: 3 additions & 3 deletions docs/syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Formal Specification
&\ \ \ |\ \ bytesConst \\
\end{align*}
Most of the syntax is self explantory. Syntax unique to Scrypt will be covered later.
Most of the syntax is self explantory. Syntax unique to sCrypt will be covered later.

Line comment starts with ``//`` and block comment comes between ``/*`` and ``*/``.

Expand All @@ -56,7 +56,7 @@ Basic Types
Domain-Spcecific Types
----------------------

To increase safety, Scrypt introduces meaningful types that help with catching semantic errors at compile time.
To increase safety, sCrypt introduces meaningful types that help with catching semantic errors at compile time.
These types add meaning to a raw ``bytes``.
They must be explicitly casted from ``bytes`` with a type constructor.

Expand Down Expand Up @@ -151,4 +151,4 @@ Operators

Scoping
=======
Scoping in Scrypt follows the prevailing scoping rules of C99 and Solidity.
Scoping in sCrypt follows the prevailing scoping rules of C99 and Solidity.

0 comments on commit b3f3966

Please sign in to comment.