More About Token Creation
Just like with resim, you can create tokens and badges inside your components. You already learned how to create fixed supply tokens if you have done the HelloWorld example. Let's learn how to create badges and mutable supply tokens !
Fixed supply tokens and badges
To create tokens and badges, you will use the
ResourceBuilder utility. It allows you to specify metadata, specify the supply and define who can mint, burn and update its metadata. When creating tokens and badges of fixed supply, a bucket is returned containing the created resources.Here is an example of a component creating an access badge and a token. The tokens are stored in a vault of the component and the badge is returned to the caller.
1
use scrypto::prelude::*;
2
3
blueprint! {
4
struct TokenCreator {
5
token_vault: Vault
6
}
7
8
impl TokenCreator {
9
pub fn new() -> (Component, Bucket) {
10
11
// Create a badge with fixed supply of 1
12
let badge = ResourceBuilder::new_fungible(DIVISIBILITY_NONE)
13
.metadata("name", "Acces Badge")
14
.metadata("symbol", "TB")
15
.metadata("icon_url", "https://badge_website.com/icon.ico")
16
.metadata("url", "https://badge_website.com")
17
.initial_supply_fungible(1);
18
19
// Create tokens with fixed supply of 1 000 000 000
20
let tokens = ResourceBuilder::new_fungible(DIVISIBILITY_MAXIMUM)
21
.metadata("name", "Really Cool Token")
22
.metadata("symbol", "RCT")
23
.initial_supply_fungible(1_000_000_000);
24
25
let component = Self {
26
token_vault: Vault::with_bucket(tokens)
27
}
28
.instantiate();
29
30
// Don't forget! At the end of a function of method,
31
// all buckets must be stored in a vault or returned.
32
(component, badge)
33
}
34
}
35
}
Copied!
Mutable supply tokens and badges
As with resim, to create a mutable supply resource, you first need a minter badge. If you then want your component to be the only one allowed to mint and burn the resources, you can store the minter badge inside one of its vaults like in the next example:
1
use scrypto::prelude::*;
2
3
blueprint! {
4
struct TokenCreator {
5
minter_badge: Vault,
6
token_vault: Vault
7
}
8
9
impl TokenCreator {
10
pub fn new() -> (Component, Bucket) {
11
let minter_badge = ResourceBuilder::new_fungible(DIVISIBILITY_NONE)
12
.initial_supply_fungible(1);
13
14
// Create a mutable supply token and specify
15
// the resource definition of the badge allowed to mint and burn.
16
// Notice that new_token_mutable does not return a bucket but only a resource_definition.
17
let token_resource_def = ResourceBuilder::new_fungible(DIVISIBILITY_MAXIMUM)
18
.metadata("name", "Really Cool Token - but mutable")
19
.metadata("symbol", "RCTM")
20
.flags(MINTABLE | BURNABLE)
21
.badge(minter_badge.resource_def(), MAY_MINT | MAY_BURN)
22
.no_initial_supply();
23
24
// Now we can mint tokens
25
let tokens = token_resource_def.mint(1000, minter_badge.present());
26
27
// It's the same when creating mutable badges (divisibility of 0)
28
let badge_resource_def = ResourceBuilder::new_fungible(DIVISIBILITY_ZERO)
29
.metadata("name", "Mutable Badge")
30
.flags(MINTABLE | BURNABLE)
31
.badge(minter_badge.resource_def(), MAY_MINT | MAY_BURN)
32
.no_initial_supply();
33
34
let badge = badge_resource_def.mint(1, minter_badge.present());
35
36
let component = Self {
37
minter_badge: Vault::with_bucket(minter_badge),
38
token_vault: Vault::with_bucket(tokens)
39
}
40
.instantiate();
41
42
43
(component, badge)
44
}
45
}
46
}
Copied!
Notice that we do
minter_badge.present() when calling mint. That's because the mint method expect a BucketRef and not a Bucket. Calling present() on a Bucket transforms it into a BucketRef.Because we saved the minter badge in one of the component's vault, we are able to mint and burn the resources in another method:
1
pub fn burn_badge(&mut self, badge_to_burn: Bucket) {
2
// Take the minter badge out of the vault
3
let badge_bucket = self.minter_badge.take(1);
4
5
// Burn the provided badge
6
badge_to_burn.burn(badge_bucket.present());
7
8
// Put the badge back into its vault
9
self.minter_badge.put(badge_bucket);
10
}
11
12
pub fn mint_tokens(&mut self) -> Bucket {
13
// Take the badge out of the vault
14
let badge_bucket = self.minter_badge.take(1);
15
16
// Let's mint 100 RCTM
17
let bucket = self.token_vault.resource_def().mint(100, badge_bucket.present());
18
19
// Put the badge back into its vault
20
self.minter_badge.put(badge_bucket);
21
22
// Return the minted tokens
23
bucket
24
}
Copied!
Because badges are used a lot, it can become annoying to always take the badge from the vault and having to put it back at the end. That's why the Radix team added the
authorize method on vaults:1
pub fn burn_badge(&mut self, badge_to_burn: Bucket) {
2
self.minter_badge.authorize(|badge| {
3
badge_to_burn.burn_with_auth(badge);
4
});
5
}
6
7
pub fn mint_tokens(&mut self) -> Bucket {
8
self.minter_badge.authorize(|badge| {
9
self.token_vault.resource_def().mint(100, badge)
10
})
11
// Notice, there is no semicolon. The created bucket will be returned.
12
}
Copied!
Much cleaner don't you think ?
Last modified 4mo ago
Copy link
Edit on GitHub