Skip to content

Commit c52bfd9

Browse files
Chore: fix minor mistakes (#100)
1 parent 4d31c44 commit c52bfd9

15 files changed

+36
-36
lines changed

pages/service/assets.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,19 @@
22
title: Assets in Beam
33
---
44

5-
import { Callout } from 'nextra/components'
5+
import { Callout } from "nextra/components";
66

77
# Assets
88

9-
Asset management is a crucial part of the Beam integration within your game. Depending on-chain activities that you want to support your in-game economy, you have the option to manage assets on behalf of the profiles you created, but also list - buy and make offers on assets through the Beam sdk.
10-
11-
By providing these options through the sdk, you are able to create a frictionless in-game marketplace build on beam without having to worry about creating infrastructure to support it.
9+
Asset management is a crucial part of the Beam integration within your game. Depending on on-chain activities that you want to support in your in-game economy, you have the option to manage assets on behalf of the profiles you created, but also list - buy and make offers on assets through the Beam sdk.
1210

11+
By providing these options through the sdk, you are able to create a frictionless in-game marketplace built on beam without having to worry about creating infrastructure to support it.
1312

1413
### Roadmap
1514

1615
Throughout the coming months, we'll be releasing additional features that will help you to provide a more complete marketplace experience, with features ranging from programmatic offers, auctions and extensive filtering options to allow you to create a full-fledged in-game marketplace solely by relying on the Beam marketplace.
1716

1817
<Callout emoji="🛠️">
19-
Feel like something is missing, and needs to be prioritized? Check out our [2023 roadmap](/service/roadmap) or let's have a chat through build@onbeam.com
18+
Feel like something is missing, and needs to be prioritized? Check out our
19+
[2023 roadmap](/service/roadmap) or let's have a chat through build@onbeam.com
2020
</Callout>

pages/service/assets/managing-profile-assets.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Note that depending on the role of our companion app within your game, [users th
1212

1313
### Currency transfers (ERC20)
1414

15-
If we registered an ERC20 contract for your game, you are able to manage the ERC20 assets in all the profiles that you created. Sending around these tokens is easy. We simply expect you to know the ID of the sender, as well as the ID of the receiver, both of which you should have created a Profile for.
15+
If we registered an ERC20 contract for your game, you are able to manage the ERC20 assets in all the profiles that you created. Sending these tokens around is easy. We simply expect you to know the ID of the sender, as well as the ID of the receiver, both of which you should have created a Profile for.
1616

1717
Initiating a token transfer would look something like this. In the example below, we are not considering more complicated features like sponsoring transactions just yet - the transaction will be paid for by you - the game developer.
1818

@@ -51,12 +51,12 @@ const transaction = await beam.assets.transferAsset("your-sender-id", {
5151
// }
5252
```
5353

54-
### Native transfers (Merit Circle)
54+
### Native transfers (BEAM)
5555

56-
Lastly - we offer you the possibility to transfer our native token: Merit Circle. Depending on the context of your game, you might want to be able to transfer our native token around between profiles.
56+
Lastly - we offer you the possibility to transfer our native token: BEAM. Depending on the context of your game, you might want to be able to transfer our native token around between profiles.
5757

5858
```typescript
59-
const transaction = await beam.assets.transferAsset("your-sender-id", {
59+
const transaction = await beam.assets.transferNativeToken("your-sender-id", {
6060
receiverEntityId: "your-receiver-id",
6161
amountToTransfer: "10", // 10 means 10 - we don't expect you to consider any other format like gwei
6262
});

pages/service/assets/reading-profile-assets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ However, depending on the token types there are a few caveats, as we are using a
1212

1313
By running the following method, you will receive all ERC721 and ERC1155 type assets within a profile for all the contracts we registered for your game. As there could be quite a few assets, the response is paginated.
1414

15-
Note that at the moment of writing, we do not expose filtering options yet - but they are expected to drop soon in order for you to filter in different ways to get to meaningful results.
15+
Note that at the moment of writing, we do not expose filtering options yet - but they are expected to drop soon in order for you to filter in different ways to get meaningful results.
1616

1717
```typescript
1818
const profileAssets = await beam.assets.getProfileAssets("entity-id");

pages/service/companion/connecting-your-users.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ title: Connecting your users
66

77
What is important to understand is that the Profiles entity within Beam is not exclusively a matter of players. Profiles could be used for various purposes, one of which is [match profiles](/service/profiles/match-profiles).
88

9-
However - in our opinion - it makes a ton of sense to create a Profile for each of your players as soon as you want something to happen on-chain. You can use these player profiles to manage user assets. On-chain tokens they earned (or bought), NFTs they minted (or you minted on their behalf) all can be send to the player profile for each player.
9+
However - in our opinion - it makes a ton of sense to create a Profile for each of your players as soon as you want something to happen on-chain. You can use these player profiles to manage a user and their assets. On-chain tokens they earned (or bought), NFTs they minted (or you minted on their behalf) all can be sent to the player profile for each player.
1010

11-
In order to allow players to see and manage their assets outside of your game, we offer a way to link-up their profile to an SSO authenticated user identity. While it's not required, the companion app offers an extension of the web3 experience where users are able to manage, give a way and trade assets, without you having to facilitate this.
11+
In order to allow players to see and manage their assets outside of your game, we offer a way to link-up their profile to an SSO authenticated user identity. While it's not required, the companion app offers an extension of the web3 experience where users are able to manage, give away and trade assets, without you having to facilitate this.
1212

1313
### Connection request
1414

15-
If you want to allow players to control their assets outside of your game, providing them the web3 experience, you would need ot create a connection request for a profile.
15+
If you want to allow players to control their assets outside of your game, providing them the web3 experience, you would need to create a connection request for a profile.
1616

1717
```typescript
1818
const request = await beam.profiles.createConnectionRequest("profile-id", {

pages/service/companion/introduction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { Callout, Cards, Card } from "nextra/components";
66

77
# Beam Companion
88

9-
We recently released the Beam Companion app. The app is meant for allowing users to manage and access their on-chain NFTs earned through playing your game.
9+
We recently released the Beam Companion app. The app allows users to manage and access their on-chain NFTs earned through playing your game.
1010

1111
Through our SDK implementation, we give you the power to generate a secure connection request that enables the user to create a connection between their in-game profile and Beam identity account (the in-app user).
1212

pages/service/companion/verifying-webhooks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Verifying connections
44

55
# Verify user connections
66

7-
After the user scans the QR code and connects their user-account to the profile, you will receive an incoming webhook on the provided callbackUrl.
7+
After user scans the QR code and connects their user-account to the profile, you will receive an incoming webhook on the provided callbackUrl.
88

99
```typescript
1010
const request = await beam.profiles.createConnectionRequest("profile-id", {

pages/service/marketplace/introduction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Callout } from "nextra/components";
99
In order to get a marketplace going, we offer various methods that can help you get started with listing assets.
1010
Keep in mind that the marketplace itself is a pre-release product waiting to be released in Q4.
1111

12-
In order to create a full marketplace integration it's important to understand all of the possibilities that you have.
12+
In order to create a full marketplace integration it is important to understand all of the possibilities that you have.
1313

1414
- [Currencies](/service/marketplace/currencies): Supported currencies in Beam marketplace
1515

@@ -21,7 +21,7 @@ In order to create a full marketplace integration it's important to understand a
2121

2222
### Roadmap
2323

24-
Throughout the coming months, we'll be releasing additional features that will help you to provide a more complete marketplace experience, with features ranging from programmatic offers, auctions and extensive filtering options to allow you to create a full-fledged in-game marketplace solely by relying on the Beam marketplace.
24+
Throughout the coming months, we'll be releasing additional features that will help you provide a more complete marketplace experience, with features ranging from programmatic offers, auctions and extensive filtering options to allow you to create a full-fledged in-game marketplace solely by relying on the Beam marketplace.
2525

2626
<Callout emoji="🛠️">
2727
Feel like something is missing, and needs to be prioritized? Check out our

pages/service/marketplace/listing-assets.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## Listing an asset
22

3-
In order to list an asset on behalf of a profile you need to pass us some information about the listing.
3+
In order to list an asset on behalf of a profile you need to give us some information about the listing.
44

55
```typescript
66
const transaction = await beam.marketplace.listAsset('profile-seller-id', {
@@ -16,11 +16,11 @@ const transaction = await beam.marketplace.listAsset('profile-seller-id', {
1616
// }
1717
```
1818

19-
Different intricacies on the different selling types will be provided at a later date. To keep things simple, we advice to start listing with the 'FixedPrice' sell type only.
19+
Different intricacies on the different selling types will be provided at a later date. To keep things simple, we advise you to start listing with the 'FixedPrice' sell type only.
2020

2121
## Accessing listed items for your game
2222

23-
At the moment, we provide a method that allows you to retrieve all the listed items of a profile. Since we just listed an item, you can now verify whenever the item is actually for sale by calling the `getListedAssetsForProfile` method.
23+
At the moment, we provide a method that allows you to retrieve all the listed items of a profile. Since we just listed an item, you can now verify whenever the item is actually for sale by calling `getListedAssetsForProfile` method.
2424

2525
```typescript
2626
const listings = await beam.marketplace.getListedAssetsForProfile(

pages/service/profiles/match-profiles.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# Match profiles
22

3-
One of the less obvious use-cases for profiles is using them for escrow. A common scenario in Web3 games are games where players put their assets on the line. Every player can participiate in a PvP-match, but has to put one of their assets on the line - and you don't want players to be able to simply disconnect or moving their assets through the companion app right before they loose a match.
3+
One of the less obvious use-cases for profiles is using them for escrow. A common scenario in Web3 games are games where players put their assets on the line. Every player can participiate in a PvP-match, but has to put one of their assets on the line - and you don't want players to be able to simply disconnect or moving their assets through the companion app right before they lose a match.
44

55
It could make sense to create a profile for these types of PvP matches - requiring everyone who wants to join a match to send one of their assets into said match profile. As the match profile was never [linked to a user](/service/profiles/users-and-profiles), it remains in your custody as the game developer - offering no way for users to further interact with these assets up until the point that you send them back to their player-profile.
66

7-
Let's go through the steps you would need to take in order to properly set this up within by providing an actual scenario. In our scenario, Player A wants to create a 1v1 PvP match where the winner takes all. They go through the game it's interface for creating a match and set-up the rules/preferences for that match.
7+
Let's go through the steps you would need to take in order to properly set this up within by providing an actual scenario. In our scenario, Player A wants to create a 1v1 PvP match where the winner takes all. They go through the game's interface for creating a match and set-up the rules/preferences for that match.
88

9-
The first step you as the game developer would need to do is to create a match profile. Please note that since the match is a new profile, it's important to track which player (in our case: player A) initiated the match, and to store the matchID somewhere with the playerID.
9+
The first step you as the game developer would need to take is to create a match profile. Please note that since the match is a new profile, it's important to track which player (in our case: player A) initiated the match, and to store the matchID somewhere with the playerID.
1010

1111
```typescript
1212
const match = await beam.profiles.createProfile("your-match-id");
@@ -36,7 +36,7 @@ const playerAssets = await beam.assets.getProfileAssets("your-player-a-id", {
3636
});
3737
```
3838

39-
Once both player selected their asset they need to be moved to the match profile. Once the transfer is completed, the asset is outside of the players their control. Note that at the moment of writing we don't offer a way to 'listen' to on-chain events, but as per our [roadmap](/service/roadmap), we are aiming to have this ready at the end of 2023.
39+
Once both players selected their assets, they need to be moved to the match profile. When transfer is completed, the assets are outside of players' control. Note that at the moment of writing we don't offer a way to 'listen' to on-chain events, but as per our [roadmap](/service/roadmap), we are aiming to have this ready at the end of 2023.
4040

4141
Transferring player A their asset:
4242

pages/service/profiles/minting-profiles.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Minting profiles
22

3-
Another use case for profiles could be minting-profiles. You might have asset contracts deployed on beam which need to mint on-demand - but you don't want everyone to be able mint whenever they want, so the contract has a pre-defined allowlist of addresses that are able to mint assets for the contract.
3+
Another use case for profiles could be minting-profiles. You might have asset contracts deployed on beam which need to be minted on-demand - but you don't want everyone to be able mint whenever they want, so the contract has a pre-defined allowlist of addresses that are able to mint assets for the contract.
44

55
If your contracts support extending this list of addresses, you could simply create a profile and add the address of the profile to the allowlist once.
66

@@ -21,7 +21,7 @@ const minter = await beam.profiles.createProfile("your-minter-id");
2121

2222
Take the wallet address of the profile you just created, and add it to the allowlist of the contract on-chain. This gives you the possibility to use the minting profile through our SDK to mint assets on demand.
2323

24-
After the address is whitelisted, minting an asset is as simple as creating a new transaction on behalf of the minter profile. As the minter-profile is whitelisted, you're (through the api key) are in full control of minting assets. If you would like to mint an asset to a player's profile, it would be as simple as doing the following:
24+
After the address is whitelisted, minting an asset is as simple as creating a new transaction on behalf of the minter profile. As the minter-profile is whitelisted, you (through the api key) are in full control of minting assets. If you would like to mint an asset to a player's profile, it would be as simple as doing the following:
2525

2626
```typescript
2727
const player = await beam.profiles.getProfile("your-player-id");

pages/service/profiles/treasury-profiles.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ const treasury = await beam.profiles.createProfile("your-treasury-id");
1919
// }
2020
```
2121

22-
The treasury profile would be a profile like any other: an account abstraction that is within your control authorized through the API key. By us adding the contracts for your pre-minted assets to your game, and you sending the pre-minted assets to the treasury profile it's wallet address, you essentially allow yourself to move these assets around from the profile to any other of your profiles through our sdk.
22+
The treasury profile would be a profile like any other: an account abstraction that is within your control authorized through the API key. By us adding the contracts for your pre-minted assets to your game, and you sending the pre-minted assets to the treasury's profile wallet address, you essentially allow yourself to move these assets around from the profile to any other of your profiles through our sdk.
2323

2424
By never creating a connection request for this profile as described in the [users and profiles](/service/profiles/users-and-profiles), you won't have a risk of anyone touching the assets within the profile except for someone authorized by the API keys.
2525

26-
If pre-minted assets get distributed in batches, you might want to create a treasury profile per batch - or periodically send assets to the profile it's wallet address - managing these profiles is up to you. Do keep in mind that everyone who possesses or is able to get access to the read-and-write API key we provided to you, is able to move around these assets freely between profiles of your game.
26+
If pre-minted assets get distributed in batches, you might want to create a treasury profile per batch - or periodically send assets to the profile's wallet address - managing these profiles is up to you. Do keep in mind that everyone who possesses or is able to get access to the read-and-write API key we provided to you, is able to move around these assets freely between profiles of your game.

pages/service/profiles/users-and-profiles.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
What is important to understand is that the Profiles entity within Beam is not exclusively a matter of players. Profiles could be used for various purposes, one of which is [match profiles](/service/profiles/match-profiles).
44

5-
However - in our opinion - it makes a ton of sense to create a Profile for each of your players as soon as you want something to happen on-chain. You can use these player profiles to manage user assets. On-chain tokens they earned (or bought), NFTs they minted (or you minted on their behalf) all can be send to the player profile for each player.
5+
However - in our opinion - it makes a ton of sense to create a Profile for each of your players as soon as you want something to happen on-chain. You can use these player profiles to manage a user and their assets. On-chain tokens they earned (or bought), NFTs they minted (or you minted on their behalf) all can be sent to the player profile for each player.
66

7-
In order to allow players to see and manage their assets outside of your game, we offer a way to link-up their profile to an SSO authenticated user identity. While it's not required, the companion app offers an extension of the web3 experience where users are able to manage, give a way and trade assets, without you having to facilitate this.
7+
In order to allow players to see and manage their assets outside of your game, we offer a way to link-up their profile to an SSO authenticated user identity. While it's not required, the companion app offers an extension of the web3 experience where users are able to manage, give away and trade assets, without you having to facilitate this.
88

99
### Connection request
1010

11-
If you want to allow players to control their assets outside of your game, providing them the web3 experience, you would need ot create a connection request for a profile.
11+
If you want to allow players to control their assets outside of your game, providing them the web3 experience, you would need to create a connection request for a profile.
1212

1313
```typescript
1414
const request = await beam.profiles.createConnectionRequest("your-player-id", {

0 commit comments

Comments
 (0)