Skip to content

Commit

Permalink
Fix typos (#48)
Browse files Browse the repository at this point in the history
* fix typos

* fix typos

* fix typos

* fix typos
  • Loading branch information
omahs authored Feb 19, 2024
1 parent f43d921 commit e8b2969
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 13 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Solana.Unity is a ported version of [Solnet](https://blockmountain.io/Solnet/),

If you are looking for the installable version via Unity Package Manager with examples, see here: https://github.com/magicblock-labs/Solana.Unity-SDK.

Several changes have been made to make it compatible with Unity, incompatibile libraries have been replaced and external dependencies have been reduced. The API and documentation remain unchanged. The original tests are run on every commit.
Several changes have been made to make it compatible with Unity, incompatible libraries have been replaced and external dependencies have been reduced. The API and documentation remain unchanged. The original tests are run on every commit.

## Solnet

Expand Down Expand Up @@ -67,7 +67,7 @@ Solnet is Solana's .NET SDK to integrate with the .NET ecosystem. Wherever you a
- Name Service Program
- Shared Memory Program

For the sake of maintainability and sometimes due to the size and complexity of some other programs, this repository will only contain Solana's Native Programs and Programs who are part of the SPL,
For the sake of maintainability and sometimes due to the size and complexity of some other programs, this repository will only contain Solana's Native Programs and Programs which are part of the SPL,
for a list of other commonly needed programs see below:

- [Serum](https://github.com/bmresearch/Solnet.Serum/)
Expand Down Expand Up @@ -428,7 +428,7 @@ var sig = wallet.Send(source, 12.75D, target, feePayer);

## Support

Consider supporting us for mantaining the integration with Unity:
Consider supporting us for maintaining the integration with Unity:

* Sol Address: **59JofSV1DiU2rrhFRghvFY2j8Pmhq4cgbEp6dSTJMiHx**

Expand Down
6 changes: 3 additions & 3 deletions docs/articles/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Solnet is Solana's .NET integration library. It implements the entire solana JSON RPC API, both HTTP and WebSocket APIs. This allows any .NET developer to quickly integrate with the Solana ecosystem with very little work.
With the power of the .NET ecosystem and Solnet, anyone can quickly develop for Desktop, Web (ASP.NET, Blazor WebAssembly) and Mobile (MAUI, Xamarin, Avalonia), and integrate the powerful Solana ecosystem in a shared code base.
Given that we've achieve full coverage of the API, you can rest assured that the library own API won't have major breaking changes in the future.
Given that we've achieved full coverage of the API, you can rest assured that the library own API won't have major breaking changes in the future.

### Features

Expand All @@ -24,7 +24,7 @@ Given that we've achieve full coverage of the API, you can rest assured that the

## 2- How to use

Before you start, we recommend you get acquainted with the [Solana Documentation](https://docs.solana.com/). The library implements the entire RPC API described [here](https://docs.solana.com/developing/clients/jsonrpc-api). While our entire documentation is based on this (we even made some contributions to the docs while developing Solnet), not everything can be deduced from our docs. Some terms and definitions might seem a bit foreign, hence our recomendation to get acquainted with the docs, and specially some of the [terms](https://docs.solana.com/terminology).
Before you start, we recommend you get acquainted with the [Solana Documentation](https://docs.solana.com/). The library implements the entire RPC API described [here](https://docs.solana.com/developing/clients/jsonrpc-api). While our entire documentation is based on this (we even made some contributions to the docs while developing Solnet), not everything can be deduced from our docs. Some terms and definitions might seem a bit foreign, hence our recommendation to get acquainted with the docs, and specially some of the [terms](https://docs.solana.com/terminology).

To get started using Solnet all you need is to have dotnet 5.0 installed.

Expand All @@ -44,4 +44,4 @@ Read more about the [package description](package_description.md) and the [hello

So far the library is being actively developed, but it is already very stable. Unfortunately, during our testing we found some issues regarding integration with Blazor WebAssembly.
- The first issue, ends up being due to design decisions, you are restricted to the *Async functions, as the synchronous versions will throw a PlatforNotSupportedException.
- The second issue seems to be some sort of problem limited to blazor that we haven't been able to trace yet. When using WebSockets in the browser, the connection will be forcefully closed from the client side with an error 1006. This issue only occurs in the browser, has we've successfully tested the same code running in console apps for several hours.
- The second issue seems to be some sort of problem limited to blazor that we haven't been able to trace yet. When using WebSockets in the browser, the connection will be forcefully closed from the client side with an error 1006. This issue only occurs in the browser, as we've successfully tested the same code running in console apps for several hours.
10 changes: 5 additions & 5 deletions docs/articles/hello_world.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Console.WriteLine($"TxHash: {transactionHash.Result}");
```

Some takeaways from the previous code:
- The request ammount sounds huge, be mindfull that 1 Sol = 1 Billion lamports. Both the balance and airdrop methods use lamports as units.
- The request amount sounds huge, be mindful that 1 Sol = 1 Billion lamports. Both the balance and airdrop methods use lamports as units.
- The requestAirdrop request returns a transaction hash. Only after about 1 minute will the funds be available (depending on [commitment parameter](https://docs.solana.com/developing/clients/jsonrpc-api#configuring-state-commitment) levels)

The delay between the request transaction and its confirmation means we can't do requests straight away that depend on having funds. That brings us to the next part.
Expand Down Expand Up @@ -109,8 +109,8 @@ var subscription = streamingRpcClient.SubscribeSignature(transactionHash.Result,
});
```

With the streaming client, every method works the same. When you subscribe to any method, you receive a subscription state object (this object will allow you to unsubscribe at any time or to receive notifications about changes to the state of the subscription) and you need to pass an handle to a data handler method that receives a SubscriptionState and the data itself (with the `SubscriptionState` parameter, you can reuse your data handlers and still know which subscription triggered a given update).
Diving deeper into the example data handler, when you are notified its possible that there were errors with a given transaction, but if everything goes right, then the `Error` value should be null. And now requesting the balance should return the value requested.
With the streaming client, every method works the same. When you subscribe to any method, you receive a subscription state object (this object will allow you to unsubscribe at any time or to receive notifications about changes to the state of the subscription) and you need to pass a handle to a data handler method that receives a SubscriptionState and the data itself (with the `SubscriptionState` parameter, you can reuse your data handlers and still know which subscription triggered a given update).
Diving deeper into the example data handler, when you are notified it's possible that there were errors with a given transaction, but if everything goes right, then the `Error` value should be null. And now requesting the balance should return the value requested.

Note: if your program keeps exiting before you receive the notification, add a `Console.ReadLine()` at the end of your program.

Expand Down Expand Up @@ -138,7 +138,7 @@ To sum things nicely, a transaction is a collection of instructions, each transa

The Solnet.Programs library, abstracts the usage of programs, and the creation of instructions that interact with these programs. For this example, we are using the static class `MemoProgram`.

Putting this together wew can quickly write:
Putting this together we can quickly write:

```
var memoInstruction = MemoProgram.NewMemo(wallet.Account, "Hello Solana World, using Solnet :)");
Expand Down Expand Up @@ -170,4 +170,4 @@ You can see the entire example on our [github](https://github.com/bmresearch/Sol
Next steps:
See more [examples](https://github.com/bmresearch/Solnet/blob/master/src/Solnet.Examples/).

Read the [API](../api/Solnet.Wallet.yml).
Read the [API](../api/Solnet.Wallet.yml).
4 changes: 2 additions & 2 deletions docs/articles/package_description.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ Solnet.Wallet has [Chaos.NaCl](https://github.com/p3root/Chaos.NaCl/) and [Bounc

## Solnet.KeyStore

The assembly Solnet.KeyStore contains constructs and utilitiy methods necessary to save and restore wallets as well as encrypt and decrypt keystores.
The assembly Solnet.KeyStore contains constructs and utility methods necessary to save and restore wallets as well as encrypt and decrypt keystores.
It includes an implementation of the [Web3 Secret Storage Definition](https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition) which generates a JSON file with an encrypted keystore, with only the correct password being necessary to decrypt it. It also includes a simpler keystore implementation that is capable of restoring keys generated by the `solana-keygen` CLI tool.

The KeyStore depends on the Solnet.Wallet project assembly, plus [Chaos.NaCl](https://github.com/p3root/Chaos.NaCl/) and [BouncyCastle](https://github.com/novotnyllc/bc-csharp).

## Solnet.Programs

The Solnet.Programs assembly implements and abstracts the usage of several Solana programs. These programs are either the [Native Programs](https://docs.solana.com/developing/runtime-facilities/programs) or part of the [SPL](https://spl.solana.com/).
If you're looking for more specific implementations, than you may have to look at [Solnet.Serum](https://github.com/bmresearch/Solnet.Serum), Solnet.Pyth, Solnet.Mango or even start your own using our APIs.
If you're looking for more specific implementations, then you may have to look at [Solnet.Serum](https://github.com/bmresearch/Solnet.Serum), Solnet.Pyth, Solnet.Mango or even start your own using our APIs.

0 comments on commit e8b2969

Please sign in to comment.