Scrypto

Language for building DeFi apps on Radix.

Documentation: https://docs-babylon.radixdlt.com/main/scrypto/introduction.html

Installation

Install Rust - this requires Rust 1.60+ (if rust is already installed, upgrade with rustup update)
- Windows:
  - Download and install rustup-init.exe
  - Install "Desktop development with C++" with Build Tools for Visual Studio 2019
  - Install LLVM 13.0.1 (make sure you tick the option that adds LLVM to the system PATH)
- macOS:
  - Make sure you have the xcode command line tools: xcode-select --install.
  - Install cmake: brew install cmake
  - Install the Rust compiler:
```
    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
- Linux:
  - Make sure a C++ compiler, LLVM and cmake is installed (sudo apt install build-essential llvm cmake).
  - Install the Rust compiler:
```
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
Enable cargo in the current shell:
- Windows:
  - Start a new PowerShell
- Linux and macOS:
```
source $HOME/.cargo/env
```

Add WebAssembly target

rustup target add wasm32-unknown-unknown

Install simulator

git clone https://github.com/radixdlt/radixdlt-scrypto.git
cd radixdlt-scrypto
cargo install --path ./simulator

(Optional) Open Scrypto documentation for later use
```
./doc.sh
```

Getting Started

If you want a quick walkthrough of how to deploy and run some code, please see the Run Your First Project tutorial. If you prefer to soldier through on your own, keep reading below.

Writing Scrypto Code

Start by creating a new package:

scrypto new-package <package_name>
cd <package_name>

Check out the files under your current directory:

Source code is within src/lib.rs;
Test code is within tests/lib.rs.

Build your package:

scrypto build

Run tests:

scrypto test

Playing with Radix Engine

Action	Command
Create an account	`resim new-account`
Change the default account	`resim set-default-account <account_component_address> <account_public_key>`
Create a token with fixed supply	`resim new-token-fixed <amount>`
Create a token with mutable supply	`resim new-token-mutable <minter_resource_address>`
Create a badge with fixed supply	`resim new-badge-fixed <amount>`
Create a badge with mutable supply	`resim new-badge-mutable <minter_resource_address>`
Mint resource	`resim mint <amount> <resource_address> <minter_resource_address>`
Transfer resource	`resim transfer <amount> <resource_address> <recipient_component_address>`
Publish a package	`resim publish <path_to_package_dir>`
Call a function	`resim call-function <package_address> <blueprint_name> <function> <args>`
Call a method	`resim call-method <component_address> <method> <args>`
Export the ABI of a blueprint	`resim export-abi <package_address> <blueprint_name>`
Show info about an entity	`resim show <id>`
List all entities in simulator	`resim show-ledger`
Reset simulator state	`resim reset`

Note: The commands use the default account as transaction sender.

Project Layout

sbor: The binary data format used by Scrypto.
sbor-derive: Derives for encoding and decoding Rust struct and enum.
scrypto: Scrypto standard library.
scrypto-schema: Scrypto package schema.
scrypto-derive: Derives for defining and importing Scrypto blueprints.
radix-engine: The Scrypto execution engine.
simulator: A simulator that run Scrypto code on a filesystem based ledger.
transaction: Radix transaction manifest compiler, transaction models, signing and validationg logic.

Contribute

To learn more about how to contribute to this project, read the Contributing Guide.

License

This software/code is licensed and used pursuant to the Radix License, Version 1.0 and includes modified third party work which is reproduced here pursuant to the Apache 2.0 licensing regime. Where third party software has been used this is identified together with the appropriate open-source licence.

A copy of the Radix License, Version 1.0 may be found in the LICENSE file in the root directory of this repository.

bbarwik/radixdlt-scrypto