Skip to content

Commit 7f98c6f

Browse files
### Summary of Changes Made: (#1271)
Modular Approach: Corrected "Singer" to "Signer" in relevant sections. Fixed grammatical errors: "it look like this" → "it looks like this", "it's dependencies" → "its dependencies". Removed unnecessary apostrophe in "that's' not swappable". Adjusted phrasing of the migration process description: "Migration might not be the best word" → "Migration may not be the best word". Contribution Guide: Replaced "repo" with "repository" for clarity. Changed "you have to install Xcode" to "you must install Xcode" for stronger language. Improved phrasing in the instructions for Linux distribution and Unity website. Corrected phrasing in the .NET installation instructions using Homebrew. Made minor updates to provide clearer instructions for adding new modules and linking to external resources. Twitter URL Update: Replaced the outdated Twitter URL (https://twitter.com/) with the updated x.com format (https://x.com/) to align with the platform's rebranding.
1 parent 766f952 commit 7f98c6f

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

CONTRIBUTION.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Welcome to the web3.unity project! We appreciate your interest in contributing t
99

1010
### Forking the Repository
1111

12-
If you're unfamiliar with Forking, here is a quick guide on how to fork our repo:
12+
If you're unfamiliar with Forking, here is a quick guide on how to fork our repository:
1313

1414
1. Go to the [web3.unity repository](https://github.com/ChainSafe/web3.unity) on GitHub.
1515
2. Click the "Fork" button in the top-right corner of the page.
@@ -18,6 +18,7 @@ If you're unfamiliar with Forking, here is a quick guide on how to fork our repo
1818
## Setting Up the Development Environment
1919

2020
### macOS
21+
2122
**Note: If you're building the project for iOS, you have to install Xcode.**
2223

2324
1. **Install Unity**: Install Unity Hub by downloading it from Unity's official website.
@@ -61,7 +62,9 @@ UnitySampleProject also contains a lot of different packages that are dependent
6162
Because we have two projects, developers can often be confused about in which project they should start writing the code.
6263
General rule of thumb:
6364
1. If your code will directly use some of the Unity features, it should probably live inside the UnitySampleProject.
64-
Note: If you want to add a new module (like web3auth, ramp, or lootboxes), you should create a new package inside the Root of the repository's Packages folder.
65+
66+
Note: If you want to add a new module (like web3auth, ramp, or lootboxes), create a new package in the root of the repository's Packages folder.
67+
6568
2. If your code doesn't care much about Unity but is doing a lot of communication with the blockchain itself, you should definitely create a new csproj inside our Chainsafe.Gaming solution.
6669
6770
If you're unsure how you would actually extend Chainsafe's SDK, take a look at this lengthy [video](https://youtu.be/D6_786zPva8). It shows in depth how you can add your own code and injectors to the Chainsafe.Gaming project.

Modules.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ but don't let that stop you from creating your own project for a new module.
4848
# Dependency injection
4949

5050
Later when user requests `web3.Provider`, DI framework handles this requests and creates an
51-
instance of `JsonRpcProvider` with all it's dependencies injected using its constructor.
51+
52+
instance of `JsonRpcProvider` with all its dependencies injected using its constructor.
5253

5354
```csharp
5455
public JsonRpcProvider(JsonRpcProviderConfiguration configuration,
@@ -66,7 +67,8 @@ as dependencies.
6667

6768
# Component configuration
6869

69-
`JsonRpcProviderConfiguration` is a simple data object used to configure `JsonRpcProvider`. It look like this:
70+
`JsonRpcProviderConfiguration` is a simple data object used to configure `JsonRpcProvider`. it looks like this:
71+
7072
```csharp
7173
[Serializable]
7274
public class JsonRpcProviderConfiguration
@@ -109,7 +111,8 @@ public Web3Builder()
109111
_serviceCollection.AddSingleton<ChainProvider>();
110112
}
111113
```
112-
If you ever need to bind a service, that's' not swappable and can be used by many other components
114+
115+
If you ever need to bind a service, that's not swappable and can be used by many other components
113116
as some sort of helper, bind it here. No interface required this time.
114117

115118
If your service is platform dependent you'd have to bind it as an Environment service.
@@ -166,12 +169,14 @@ But for now there are 3 classes:
166169
* `ProviderMigration`
167170
* `SignerMigration`
168171

172+
169173
Most of code is compatible by default, but for Provider and Singer we have to use
170174
this for object instantiation:
171175
```csharp
172176
var provider = ProviderMigration.NewJsonRpcProvider("http://127.0.0.1:7545");
173177
var signer = SignerMigration.NewJsonRpcSigner(provider);
174178
```
179+
175180
_Migration might not be the best word for describing this process. Ping me (@oleksandrchainsafe) if you have better ideas._
176181

177182
# Useful links

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33

44
[<img alt="Discord" src="https://img.shields.io/discord/593655374469660673.svg?style=for-the-badge&label=Discord&logo=discord" height="20">](https://discord.gg/Q6A3YA2)
5+
56
[<img alt="Twitter" src="https://img.shields.io/twitter/follow/chainsafeth" height="20">](https://x.com/chainsafeth)
67

78
## Documentation

0 commit comments

Comments
 (0)