zink 0.1.12

Standard library for zink projects.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# Creating Zink Project

For creating a zink project, we need to install the zink toolchain `zinkup`
from `crates.io` first, the package manager `elko` will be installed along
with other tools:

```bash
cargo install zinkup
elko -h
```

Now, let's create a zink project:

```bash
elko new my-awesome-contract
Created zink project `my-awesome-contract`
```

the Zink projects are based on the [cargo projects][cargo], you can install
dependencies you need with `cargo`, the basic `Cargo.toml` will be like:

```toml
# ...

[lib]
crate-type = [ "cdylib" ]

[dependencies]
zink = "0.1.0"

# ...
```

open `my-awesome-contract/src/lib.rs`

```rust
//! my-awesome-project
#![no_std]

// For the panic handler.
#[cfg(not(test))]
extern crate zink;

/// Adds two numbers together.
#[no_mangle]
pub extern "C" fn addition(x: u64, y: u64) -> u64 {
    x + y
}
```

you'll see a standard `WASM` library in rust:

1. `#![no_std]` means we don't need the std library in this project.
2. `extern crate zink` is for importing the panic handler from library `zink` for this project.
3. `#[no_mangle]` is for exporting function `addition` to WASM, and this will be one the methods
   of your contracts.

[cargo]: https://doc.rust-lang.org/cargo/reference/manifest.html
[elko]: /cli/elko.html