Newer
Older
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# Version 3.0 (2020-10-09)
Be prepared for the ink! 3.0 release notes because the whole version was basically a rewrite of
all the major components that make up ink!. With our experience gained from previous releases
of ink! we were able to detect weak spots of the design and provided ink! with more tools,
more features and more efficiency as ever. Read more below …
## Just. Be. Rust. 3.0
In the 3.0 update we further explored the space for ink! to just feel like it was plain Rust.
With this in mind we changed the syntax slightly in order to better map from ink! to the generated
Rust code. So what users see is mostly what will be generated by ink! later.
In this vein `#[ink(storage)]` and `#[ink(event)]` structs as well as `#[ink(message)]` and
`#[ink(constructor)]` methods now need to be specified with public visibility (`pub`).
The `#[ink(constructors)]` syntax also changes and no longer uses a `&mut self` receiver but
now follows the natural Rust constructors scheme. So it is no longer possible to shoot
yourself in the foot by accidentally forgetting to initialize some important data structures.
**Old ink! 2.0:**
```rust
#[ink(storage)]
fn new_erc20(&mut self, initial_supply: Balance) {
let caller = self.env().caller();
self.total_supply.set(initial_supply);
self.balances.insert(caller, initial_supply);
}
```
**New ink! 3.0:**
```rust
#[ink(storage)]
pub fn new_erc20(initial_supply: Balance) -> Self {
let caller = self.env().caller();
let mut balances = ink_storage::HashMap::new();
balances.insert(caller, initial_supply);
Self {
total_supply: initial_supply,
balances,
}
}
```
Also ink! 3.0 no longer requires a mandatory `version` field in the header of the ink! module attribute.
Syntactically this is all it takes to port your current ink! smart contracts over to ink! 3.0 syntax.
## New Storage Module
The storage module has been reworked entirely.
Also it no longer lives in the `ink_core` crate but instead is defined as its own `ink_storage` crate.
In a sense it acts as the standard storage library for ink! smart contracts in that it provides all the
necessary tools and data structures to organize and operate the contract's storage intuitively and efficiently.
### Lazy
The most fundamental change in how you should think about data structures provided by the new `ink_storage`
crate is that they are inherently lazy. We will explain what this means below!
The `ink_storage` crate provides high-level and low-level lazy data structures.
The difference between high-level and low-level lies in the distinction in how these data structures are aware
of the elements that they operate on. For high-level data structures they are fully aware about the elements
they contains, do all the clean-up by themselves so the user can concentrate on the business logic.
For low-level data structures the responsibility about the elements lies in the hands of the contract author.
Also they operate on cells (`Option<T>`) instead of entities of type `T`.
But what does that mean exactly?
The new `ink_storage::Lazy` type is what corresponds the most to the old `ink_core::storage::Value` type. Both cache their entities and both act lazily on the storage. This means that a read or write operation is only performed when it really needs to in order to satisfy other inputs.
Data types such as Rust primitives `i32` or Rust's very own `Vec` or data structures can also be used to operate on the contract's storage, however, they will load their contents eagerly which is often not what you want.
An example follows with the below contract storage and a message that operates on either of the two fields.
```rust
#[ink(storage)]
pub struct TwoValues {
offset: i32,
a: i32,
b: i32,
}
impl TwoValues {
#[ink(message)]
pub fn set(&mut self, which: bool, new_value: i32) {
match which {
true => { self.a = self.offset + new_value; },
false => { self.b = self.offset + new_value; },
}
}
}
```
Whenever we call `TwoValues::set` always both `a` and `b` are loaded despite the fact the we only operate on one of them at a time. This is very costly since storage accesses are in fact database look-ups.
In order to prevent this eager loading of storage contents we can make use of `ink_storage::Lazy` or other lazy data structures defined in that crate:
```rust
#[ink(storage)]
pub struct TwoValues {
offset: i32,
a: ink_storage::Lazy<i32>,
b: ink_storage::Lazy<i32>,
}
impl TwoValues {
#[ink(message)]
pub fn set(&mut self, which: bool, new_value: i32) {
match which {
true => { self.a = offset + new_value; },
false => { self.b = offset + new_value; },
}
}
}
```
Now `a` and `b` are only loaded when the contract really needs their values.
Note that `offset` remained `i32` since it is always needed and could spare the minor overhead of the `ink_storage::Lazy` wrapper.
### HashMap
In the follow we explore the differences between the high-level `ink_storage::collections::HashMap`
and the low-level `ink_storage::lazy::LazyHashMap`. Both provide very similar functionality in that they map some generic key to some storage entity.
However, their APIs look very different. Whereas the `HashMap` provides a rich and high-level API that is comparable to that of Rust's very own `HashMap`, the `LazyHashMap` provides only a fraction of the API and also operates on `Option<T>` values types instead of `T` directly. It is more similar Solidity mappings than to Rust's `HashMap`.
The fundamental difference of both data structures is that `HashMap` is aware of the keys that have been stored in it and thus can reconstruct exactly which elements and storage regions apply to it. This enables it to provide iteration and automated deletion as well as efficient way to defragment its underlying storage to free some storage space again. This goes very well in the vein of Substrate's storage rent model where contracts have to pay for the storage they are using.
| Data Structure | level of abstraction | caching | lazy | element type | container |
|:--|:-:|:-:|:-:|:-:|:-:|
| `T` | - | yes | no | `T` | primitive value |
| `Lazy<T>` | high-level | yes | yes | `T` | single element container |
| `LazyCell<T>` | low-level | yes | yes | `Option<T>` | single element, no container |
| `Vec<T>` | high-level | yes | yes | `T` | Rust vector-like container |
| `LazyIndexMap<T>` | low-level | yes | yes | `Option<T>` | similar to Solidity mapping |
| `HashMap<K, V>` | high-level | yes | yes | `V` (key type `K`) | Rust map-like container |
| `LazyHashMap<K, V>` | low-level | yes | yes | `Option<V>` (key type `K`) | similar to Solidity mapping |
There are many more! For more information about the specifics please take a look into [the `ink_storage` crate documentation](https://paritytech.github.io/ink/ink_storage/).
### Spread & Packed Modes
Storing or loading complex data structures to and from contract storage can be done in many different ways. You could store all information into a single storage cell or you could try to store all information into as many different cells as possible. Both strategies have pros and cons under different conditions.
For example it might be a very good idea to store all the information under the same cell if all the information is very compact. For example when we are dealing with a byte vector that is expected to never be larger than approx a thousand elements it would probably be more efficient if we store all those thousand bytes in the same cell and especially if we often access many of those (or all) in our contract messages.
On the other hand spreading information across as many cells as possible might be much more efficient if we are dealing with big data structures, a lot of information that is not compact, or when messages that operate on the data always only need a small fraction of the whole data.
An example for this use case is if you have a vector of user accounts where each account stores potentially a lot of information, e.g. a 32-byte hash etc and where our messages only every operate on only a few of those at a time.
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
The `ink_storage` crate provides the user full control over the strategy or a mix of these two root strategies through some fundamental abstractions that we are briefly presenting to you.
### Default: Spreading Mode
By default ink! spreads information to as many cells as possible. For example if you have the following `#[ink(storage)]` struct every field will live in its own single storage cell. Note that for `c` all 32 bytes will share the same cell!
```rust
#[ink(storage)]
pub struct Spreaded {
a: i32,
b: ink_storage::Lazy<i32>,
c: [u8; 32],
}
```
### Packing Storage
We can alter this behaviour by using the `ink_storage::Pack` abstraction:
```rust
pub struct Spreaded {
a: i32,
b: ink_storage::Lazy<i32>,
c: [u8; 32],
}
#[ink(storage)]
pub struct Packed {
packed: ink_storage::Pack<Spreaded>,
}
```
Now all fields of `Spreaded` will share the same storage cell. This means whenever one of them is stored to or loaded from the contract storage, all of them are stored or loaded. A user has to choose wisely what mode of operation is more suitable for their contract.
These abstractions can be combined in various ways, yielding full control to the users. For example, in the following only `a` and `b` share a common storage cell while `c` lives in its own:
```rust
pub struct Spreaded {
a: i32,
b: ink_storage::Lazy<i32>,
}
#[ink(storage)]
pub struct Packed {
packed: ink_storage::Pack<Spreaded>,
c: [u8; 32],
}
```
### Spreading Array Cells
If we prefer to store all bytes of `c` into their own storage cell we can make use of the `SmallVec` data structure. The `SmallVec` is a high-level data structure that allows to efficiently organize a fixed number of elements similar to a Rust array. However, unlike a Rust array it acts lazily upon the storage and spreads its elements into different cells.
```rust
use typenum::U32;
pub struct Spreaded {
a: i32,
b: ink_storage::Lazy<i32>,
}
#[ink(storage)]
pub struct Packed {
packed: ink_storage::Pack<Spreaded>,
c: SmallVec<u8, U32>,
}
```
### Opting-out of Storage
If you are in need of storing some temporary information across method and message boundaries ink! will have your back with the `ink_storage::Memory` abstraction. It allows you to simply opt-out of using the storage for the wrapped entity at all and thus is very similar to Solidity's very own `memory` annotation.
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
An example below:
```rust
#[ink(storage)]
pub struct OptedOut {
a: i32,
b: ink_storage::Lazy<i32>,
c: ink_storage::Memory<i32>,
}
```
The the above example `a` and `b` are normal storage entities, however, `c` on the other hand side will never load from or store to contract storage and will always be reset to the default value of its `i32` type for every contract call.
It can be accesses from all ink! messages or methods via `self.c` but will never manipulate the contract storage and thus acts wonderfully as some shared local information.
### Dynamic Storage Allocator
In the previous section we have seen how the default mode of operation is to spread information and how we can opt-in to packing information into single cells via `ink_storage::Packed`.
However, what if we wanted to store a vector of a vector of `i32` for example?
Naturally a user would try to construct this as follows:
```rust
use ink_storage::Vec as StorageVec;
#[ink(storage)]
pub struct Matrix {
values: StorageVec<StorageVec<i32>>,
}
```
However, this will fail compilation with an error indicating that `StorageVec<T>` requires for its `T` to be packed (`T: PackedLayout`) which `StorageVec<T>` itself does not since it always stores all of its elements into different cells. The same applies to many other storage data sturctures provided by `ink_storage` and is a trade-off the ink! team decided for the case of efficiency of the overall system.
Instead what a user can do in order to get their vector-of-vector to be working is to make use of ink!'s dynamic storage allocator capabilities.
For this the contract author has to first enable the feature via:
```rust
use ink_lang as ink;
#[ink::contract(dynamic_storage_allocator = true)]
mod matrix {
// contract code ...
}
```
And then we can define our `Matrix` `#[ink(storage)]` as follows:
```rust
use ink_storage::{
Vec as StorageVec,
Box as StorageBox,
};
#[ink(storage)]
pub struct Matrix {
values: StorageVec<StorageBox<StorageVec<i32>>>,
}
```
With `ink_storage::Box<T>` we can use a `T: SpreadLayout` as if it was `T: PackedLayout` since the `ink_storage::Box<T>` itself suffices the requirements and can be put into a single contract storage cell. The whole concept works quite similar to how Rust's `Box` works: by an indirection - contract authors are therefore advised to make use of dynamic storage allocator capabilities only if other ways of dealing with ones problems are not applicable.
### Custom Data Sturctures
While the `ink_storage` crate provides tons of useful utilities and data structures to organize and manipulate the contract's storage contract authors are not limited by its capabilities. By implementing the core `SpreadLayout` and `PackedLayout` traits users are able to define their very own custom storage data structures with their own set of requirement and features that work along the `ink_storage` data structures as long as they fulfill the mere requirements stated by those two traits.
In the future we plan on providing some more ink! workshops and tutorials guiding the approach to design and implement a custom storage data structure.
### In Summary
The new `ink_storage` crate provides everything you need to operate on your contract's storage.
There are low-level and high-level data structures depending on your need of control.
All provided data structures operate lazily on the contract's storage and cache their reads and writes for a more gas efficient storage access.
Users should prefer high-level data structures found in the `collections` module over the low-level data structures found in the `lazy` module.
For a list of all the new storage data structure visit [`ink_storage`'s documentation](https://paritytech.github.io/ink/ink_storage/).
## ink! Attributes
For ink! 3.0 we have added some more useful ink! specific attributes to the table.
All of these ink! attributes are available to specify inside an ink! module.
An ink! module is the module that is flagged by `#[ink::contract]` containing all the ink! definitions:
```rust
use ink_lang as ink;
#[ink::contract]
mod erc20 {
#[ink(storage)]
pub struct Erc20 { ... }
impl Erc20 {
#[ink(constructor)]
pub fn new(initial_supply: Balance) -> Self { .. }
#[ink(constructor)]
pub fn total_supply(&self) -> Balance { .. }
// etc. ...
}
}
```
We won't be going into the details for any of those but will briefly present the entire set of ink! specific attributes below:
| Attribute | Where Applicable | Description |
|:--|:--|:--|
| `#[ink(storage)]` | On `struct` definitions. | Defines the ink! storage struct. There can only be one ink! storage definition per contract. |
| `#[ink(event)]` | On `struct` definitions. | Defines an ink! event. A contract can define multiple such ink! events. |
| `#[ink(anonymous)]` **new** | Applicable to ink! events. | Tells the ink! codegen to treat the ink! event as anonmyous which omits the event signature as topic upon emitting. Very similar to anonymous events in Solidity. |
| `#[ink(topic)]` | Applicate on ink! event field. | Tells the ink! codegen to provide a topic hash for the given field. Every ink! event can only have a limited number of such topic field. Similar semantics as to indexed event arguments in Solidity. |
| `#[ink(message)]` | Applicable to methods. | Flags a method for the ink! storage struct as message making it available to the API for calling the contract. |
| `#[ink(constructor)]` | Applicable to method. | Flags a method for the ink! storage struct as constructor making it available to the API for instantiating the contract. |
| `#[ink(payable)]` **new** | Applicable to ink! messages. | Allows receiving value as part of the call of the ink! message. ink! constructors are implicitely payable. |
| `#[ink(selector = "..")]` **new** | Applicable to ink! messages and ink! constructors. | Specifies a concrete dispatch selector for the flagged entity. This allows a contract author to precisely control the selectors of their APIs making it possible to rename their API without breakage. |
| `#[ink(namespace = "..")]` **new** | Applicable to ink! trait implementation blocks. | Changes the resulting selectors of all the ink! messages and ink! constructors within the trait implementation. Allows to disambiguate between trait implementations with overlapping message or constructor names. Use only with great care and consideration! |
| `#[ink(implementation)]` **new** | Applicable to ink! implementation blocks. | Tells the ink! codegen that some implementation block shall be granted access to ink! internals even without it containing any ink! messages or ink! constructors. |
## Merging of ink! Attributes
It is possible to merge attributes that share a common flagged entity.
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
The example below demonstrates this for a payable message with a custom selector.
```rust
#[ink(message)]
#[ink(payable)]
#[ink(selector = "0xCAFEBABE")]
pub fn transfer(&mut self, from: AccountId, to: AccountId, value: Balance) -> Result<(), Error> {
// actual implementation
}
```
We can also write the above ink! message definition in the following way:
```rust
#[ink(message, payable, selector = "0xCAFEBABE")]
pub fn transfer(&mut self, from: AccountId, to: AccountId, value: Balance) -> Result<(), Error> {
// actual implementation
}
```
## Trait Support
One of the most anticipated features of ink! 3.0 is its Rust trait support.
Through the new `#[ink::trait_definition]` proc. macro it is now possible to define your very own trait definitions that are then implementable by ink! smart contracts.
This allows to defined shared smart contract interfaces to different concrete implementations.
Note that this ink! trait definition can be defined anywhere, even in another crate!
### Example
Defined in the `base_erc20.rs` module.
```rust
use ink_lang as ink;
#[ink::trait_definition]
pub trait BaseErc20 {
/// Creates a new ERC-20 contract and initializes it with the initial supply for the instantiator.
#[ink(constructor)]
pub fn new(initial_supply: Balance) -> Self;
/// Returns the total supply.
#[ink(message)]
pub fn total_supply(&self) -> Balance;
/// Transfers `amount` from caller to `to`.
#[ink(message, payable)]
pub fn transfer(&mut self, to: AccountId, amount: Balance);
}
```
An ink! smart contract definition can then implement this trait definition as follows:
```rust
use ink_lang as ink;
#[ink::contract]
mod erc20 {
use base_erc20::BaseErc20;
#[ink(storage)]
pub struct Erc20 {
total_supply: Balance,
// more fields ...
}
impl BaseErc20 for Erc20 {
#[ink(constructor)]
pub fn new(initial_supply: Balance) -> Self {
// implementation ...
}
#[ink(message)]
pub fn total_supply(&self) -> Balance {
// implementation ...
}
#[ink(message, payable)]
pub fn transfer(&mut self, to: AccountId, amount: Balance) {
// implementation ...
}
}
}
```
Calling the above `Erc20` explicitely through its trait implementation can be done just as if it was normal Rust code:
```rust
// --- Instantiating the ERC-20 contract:
//
let mut erc20 = <Erc20 as BaseErc20>::new(1000);
// --- Is just the same as:
use base_erc20::BaseErc20;
let mut erc20 = Erc20::new(1000);
// --- Retrieving the total supply:
//
assert_eq!(<Erc20 as BaseErc20>::total_supply(&erc20), 1000);
// --- Is just the same as:
use base_erc20::BaseErc20;
assert_eq!(erc20.total_supply(), 1000);
```
There are still many limitations to ink! trait definitions and trait implementations.
For example it is not possible to define associated constants or types or have default implemented methods.
These limitations exist because of technical intricacies, however, please expect that many of those will be tackled in future ink! releases.
# Version 2.1 (2020-03-25)
- Add built-in support for cryptographic hashes:
- Blake2 with 128-bit and 256-bit
- Sha2 with 256-bit
- Keccak with 256-bit
- Add `ink_core::hash` module for high-level API to the new built-in hashes.
- Update `runtime-storage` example ink! smart contract to demonstrate the new built-in hashes.
# Version 2.0 (2019-12-03)
The ink! version 2.0 syntax has one major philosophy:
> Just. Be. Rust.
To accomplish this, we take advantage of all the standard Rust types and structures and use
[attribute macros](https://doc.rust-lang.org/reference/procedural-macros.html#attribute-macros) to
tag these standard structures to be different parts of the ink! language.
Anything that is not tagged with an `#[ink(...)]` attribute tag is just standard Rust, and can be
used in and out of your contract just like standard Rust could be used!
**Every valid ink! contract is required to have at least one `#[ink(constructor)]`, at least one
`#[ink(message)]` and exactly one `#[ink(storage)]` attribute.**
Follow the instructions below to understand how to migrate your ink! 1.0 contracts to this new ink!
2.0 syntax.
## Update the ink! CLI
Install the latest ink! CLI using the following command:
```bash
Andrew Jones
committed
cargo install --git https://github.com/paritytech/cargo-contract cargo-contract --force
There is a new contract metadata format you need to use. You can generate the metadata using:
cargo contract generate-metadata
This will generate a file `metadata.json` you should upload when deploying or interacting with a
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
contract.
## Declaring a Contract
The fundamental change with the new ink! syntax is how we declare a new contract.
We used to wrap the whole ink! contract into a `contract!` macro. At that point, all syntax within
the macro could be custom, and in our first iteration of the language, we used that in ways that
made our code not really Rust anymore.
Now we wrap the whole contract in a standard Rust module, and include an attribute tag to identify
this object as part of the ink! language. This means that all of our code from this point forward
will be valid Rust!
<table style="width: 100%;">
<tr>
<th>Before</th>
<th>After</th>
</tr>
<tr>
<td>
```rust
contract! {
...
}
```
</td>
<td>
```rust
#[ink::contract(version = "0.1.0")]
mod erc20 {
...
}
```
</td>
</tr>
</table>
> Note: we now require a mandatory ink! version in the header. You're welcome.
See the [ERC20 example](https://github.com/paritytech/ink/blob/master/examples/erc20/src/lib.rs).
## ink! Contract Tag
The ink! contract tag can be extended to provide other configuration information about your
contract.
### Defining Custom Types
We used to define types using a special `#![env = DefaultSrmlTypes]` tag.
Now we simply include the type definition in the `#[ink::contract(...)]` tag:
```rust
#[ink::contract(version = "0.1.0", env = MyCustomTypes)]
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
```
By default, we use `DefaultSrmlTypes`, so you don't need to define anything unless you plan to use
custom types.
### Dynamic Allocation
It is possible to enable the dynamic environment that allows for dynamic allocations by specifying
`dynamic_allocations = true` in the parameters of the ink! header. This is disabled by default.
```rust
#[ink::contract(version = "0.1.0", dynamic_allocations = true)]
```
> Note: The dynamic environment is still under research and not yet stable.
## Declaring Storage
We define storage items just the same as before, but now we need to add the `#[ink(storage)]`
attribute tag.
<table style="width: 100%;">
<tr>
<th>Before</th>
<th>After</th>
</tr>
<tr>
<td>
```rust
struct Erc20 {
total_supply: storage::Value<Balance>,
balances: storage::HashMap<AccountId, Balance>,
allowances: storage::HashMap<(AccountId, AccountId), Balance>,
}
```
</td>
<td>
```rust
#[ink(storage)]
struct Erc20 {
total_supply: storage::Value<Balance>,
balances: storage::HashMap<AccountId, Balance>,
allowances: storage::HashMap<(AccountId, AccountId), Balance>,
}
```
</td>
</tr>
</table>
See the [ERC20 example](https://github.com/paritytech/ink/blob/master/examples/erc20/src/lib.rs).
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
## Declaring Events
To update your events, you need to:
1. Change the old `event` keyword to a standard Rust `struct`.
2. Add the `#[ink(event)]` attribute tag to your `struct`.
If you were previously indexing the items in your event with `#[indexed]`:
3. Add the `#[ink(topic)]` attribute tag to each item in your event.
<table style="width: 100%;">
<tr>
<th>Before</th>
<th>After</th>
</tr>
<tr>
<td>
```rust
event Transfer {
from: Option<AccountId>,
to: Option<AccountId>,
#[indexed]
value: Balance,
}
```
</td>
<td>
```rust
#[ink(event)]
struct Transfer {
from: Option<AccountId>,
to: Option<AccountId>,
#[ink(topic)]
value: Balance,
}
```
</td>
</tr>
</table>
See the [ERC20 example](https://github.com/paritytech/ink/blob/master/examples/erc20/src/lib.rs).
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
## Environment Handler
`EnvHandler` is no longer exposed to the user and instead the environment is now always accessed via
`self.env()`.
<table style="width: 100%;">
<tr>
<th>Before</th>
<th>After</th>
</tr>
<tr>
<td>
**Getting the caller:**
```rust
let caller = env.caller();
```
**Emitting an event:**
```rust
env.emit(...)
```
</td>
<td>
**Getting the caller:**
```rust
let caller = self.env().caller();
```
**Emitting an event:**
```rust
self.env().emit_event(...)
```
</td>
</tr>
</table>
> Note: The name of the function used to emit an event was updated to `emit_event`.
## Message Functions
We used to use `pub(external)` to tag functions that could be called by the outside world.
We now simply add the attribute `#[ink(message)]`.
<table style="width: 100%;">
<tr>
<th>Before</th>
<th>After</th>
</tr>
<tr>
<td>
```rust
pub(external) fn total_supply(&self) -> Balance {
*self.total_supply
}
```
</td>
<td>
```rust
#[ink(message)]
fn total_supply(&self) -> Balance {
*self.total_supply
}
```
</td>
</tr>
</table>
See the [ERC20 example](https://github.com/paritytech/ink/blob/master/examples/erc20/src/lib.rs).
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
## Defining a Constructor
We used to define our constructor by implementing the `Deploy` trait and defining the `deploy`
function.
But now our constructor function is in the same place as the rest of our contract functions, within
the general implementation of the storage struct.
We tag these functions with the `#[ink(constructor)]` attribute. We can create multiple different
constructors by simply creating more functions with the same tag. You can name a constructor
function whatever you want (except starting with `__ink` which is reserved for all functions).
<table style="width: 100%;">
<tr>
<th>Before</th>
<th>After</th>
</tr>
<tr>
<td>
```rust
impl Deploy for Erc20 {
fn deploy(&mut self, init_supply: Balance) {
let caller = env.caller();
self.total_supply.set(init_value);
self.balances.insert(caller, init_supply);
env.emit(Transfer {
from: None,
to: Some(env.caller()),
value: init_value
});
}
}
```
</td>
<td>
```rust
impl Erc20 {
#[ink(constructor)]
fn new(&mut self, initial_supply: Balance) {
let caller = self.env().caller();
self.total_supply.set(initial_supply);
self.balances.insert(caller, initial_supply);
self.env().emit_event(Transferred {
from: None,
to: Some(caller),
amount: initial_supply,
});
}
}
```
</td>
</tr>
</table>
See the [ERC20 example](https://github.com/paritytech/ink/blob/master/examples/erc20/src/lib.rs).
## Cross Contract Calls
It is now possible to call ink! messages and ink! constructors. So ink! constructors allow
delegation and ink! messages can easily call other ink! messages.
Given another ink! contract like `mod Adder { ... }`, we can call any of its functions:
```rust
use adder::Adder;
//--snip--
#[ink(storage)]
struct Delegator {
adder: storage::Value<Adder>,
}
//--snip--
let result = self.adder.inc(by);
```
See the [delegator example](https://github.com/paritytech/ink/blob/master/examples/delegator/lib.rs).
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
## Factory Contracts
Creation of other contracts from a factory contract works pretty much the same way it did in the old
ink! language.
However, users are now required to specify the `code_hash` separately rather than in the
constructor:
```rust
.using_code(code_hash)
```
Also, they need to specify the used ink! environment (most likely `self.env()`):
```rust
create_using(self.env())
```
<table style="width: 100%;">
<tr>
<th>Before</th>
<th>After</th>
</tr>
<tr>
<td>
```rust
let accumulator = Accumulator::new(accumulator_code_hash, init_value)
.value(total_balance / 4)
.create()
.expect("failed at instantiating the accumulator contract");
```
</td>
<td>
```rust
let accumulator = Accumulator::new(init_value)
.value(total_balance / 4)
.gas_limit(12345)
.using_code(accumulator_code_hash)
.create_using(self.env())
.expect("failed at instantiating the `Accumulator` contract");
```
</td>
</tr>
</table>
See the [delegator example](https://github.com/paritytech/ink/blob/master/examples/delegator/lib.rs).
## Contract Tests
Testing contracts off-chain is done by `cargo test` and users can simply use the standard routines
of creating unit test modules within the ink! project:
```rust
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn my_test() { ... }
}
```
Test instances of contracts can be created with something like:
```rust
let contract = MyContract::my_constructor(a, b);
```
Messages can simply be called on the returned instance as if `MyContract::my_constructor` returns a
`Self` instance.
See the [flipper example](https://github.com/paritytech/ink/blob/master/examples/flipper/src/lib.rs).
**The off-chain test environment has lost a bit of power compared to the old ink! language.**
It is not currently possible to query and set special test data about the environment (such as the
caller of a function or amount of value sent), but these will be added back in the near future.
## ink!-less Implementations
It is also possible to annotate an entire impl blocks with:
```rust
#[ink(impl)]
impl Contract {
fn internal_function(&self) {
self.env().emit_event(EventName);
}
}.
```
This is useful if the `impl` block itself doesn't contain any ink! constructors or messages, but you
still need to access some of the "magic" provided by ink!. In the example above, you would not have
access to `emit_event` without `#[ink(impl)]`.