Giter VIP home page Giter VIP logo

radixdlt-scrypto's Introduction

Scrypto

CI

Language for building DeFi apps on Radix.

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

Installation

  1. Install Rust - this requires Rust 1.60+ (if rust is already installed, upgrade with rustup update)
    • Windows:
    • Linux and macOS:
      • Make sure a C++ compiler and LLVM is installed (sudo apt install build-essential llvm with Ubuntu)
      • Install Rust compiler
      curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
      
  2. Enable cargo in the current shell:
    • Windows:
      • Start a new PowerShell
    • Linux and macOS:
      source $HOME/.cargo/env
      
  3. Add WebAssembly target
    rustup target add wasm32-unknown-unknown
    
  4. Install simulator
    git clone https://github.com/radixdlt/radixdlt-scrypto.git
    cd radixdlt-scrypto
    cargo install --path ./simulator
    
  5. (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

  1. Start by creating a new package:
scrypto new-package <package_name>
cd <package_name>
  1. Check out the files under your current directory:
  • Source code is within src/lib.rs;
  • Test code is within tests/lib.rs.
  1. Build your package:
scrypto build
  1. 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-abi: Scrypto blueprint ABI.
  • 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-manifest: Radix transaction manifest compiler.

radixdlt-scrypto's People

Contributors

iamyulong avatar talekhinezh avatar dhedey avatar r001 avatar gianlucardx avatar 0xomara avatar shambupujar avatar diegomrsantos avatar cseidman avatar devmannic avatar beemdvp avatar klembee avatar quwin avatar azizi-radixdlt avatar tesslerc avatar michalzajda avatar backyard-coder avatar russellharvey avatar sennui avatar lukasgasior1 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.