Skip to content
This repository has been archived by the owner on Oct 4, 2020. It is now read-only.

Commit

Permalink
chore: deprecate dotnet (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
sleepdefic1t committed Aug 21, 2020
1 parent 455bd1b commit 0eca7ac
Show file tree
Hide file tree
Showing 24 changed files with 134 additions and 1,717 deletions.
15 changes: 9 additions & 6 deletions README.md
Expand Up @@ -2,17 +2,15 @@

Using ARK SDKs, developers can employ the programming language of their choice to build applications utilizing the ARK blockchain. **The ARK SDKs are split into two packages for each language: Client and Cryptography.**

[**Client SDKs**](guidelines/client.md) ****help developers fetch information from the ARK blockchain about its current state: which delegates are currently forging, what transactions are associated with a given wallet, and so on.
[**Client SDKs**](guidelines/client.md) help developers fetch information from the ARK blockchain about its current state: which delegates are currently forging, what transactions are associated with a given wallet, and so on.

\*\*\*\*[**Cryptography SDKs**](guidelines/crypto.md), by contrast, assist developers in working with transactions: signing, serializing, deserializing, etc.
[**Cryptography SDKs**](guidelines/crypto.md), by contrast, assist developers in working with transactions: signing, serializing, deserializing, etc.

{% hint style="info" %}
If you need to learn more about Cryptography in general, how initial key and address generation works, what is a public or private key, head over to the page link below:
{% endhint %}

{% embed url="https://learn.ark.dev/concepts/cryptography" %}


{% embed url="https://learn.ark.dev/concepts/cryptography" caption="" %}

If your application doesn't involve sending transactions, you can most likely build your application using the Client SDK alone. Otherwise, applications looking to leverage the full spectrum of ARK APIs should make use of both Client and Cryptography SDKs.

Expand All @@ -29,11 +27,16 @@ Usage guides are included for each supported language, and examples of how to us
| [C++](c++/crypto/) | [C++](c++/client/) | |
| [Elixir](elixir/crypto/) | [Elixir](elixir/client/) | |
| [Golang](golang/crypto/) | [Golang](golang/client/) | |
| [.NET](https://sdk.ark.dev/dotnet/getting-started) | [.NET](dotnet/client/) | |
| [Ruby](ruby/crypto/) | [Ruby](ruby/client/) | |
| [Rust](rust/crypto/) | [Rust](rust/client/) | |
| [Swift](swift/crypto/) | [Swift](swift/client/) | |

### Deprecated

| Crypto | Client | Frameworks |
| :--- | :--- | :--- |
| [.NET](deprecated/dotnet/crypto/) | [.NET](deprecated/dotnet/client/) | |

## Contributing

Contributions to our SDK follow the same guidelines as our general [contribution guidelines](https://docs.ark.io/guidebook/contribution-guidelines/contributing.html).
Expand Down
20 changes: 10 additions & 10 deletions SUMMARY.md
Expand Up @@ -91,16 +91,6 @@
* [API Documentation](elixir/client/api-documentation.md)
* [Examples](elixir/client/examples.md)

## DotNET

* [Installation](dotnet/installation.md)
* [Crypto](dotnet/getting-started/README.md)
* [API Documentation](dotnet/getting-started/api-documentation.md)
* [Examples](dotnet/getting-started/examples.md)
* [Client](dotnet/client/README.md)
* [API Documentation](dotnet/client/api-documentation.md)
* [Examples](dotnet/client/examples.md)

## Ruby

* [Installation](ruby/installation.md)
Expand All @@ -126,3 +116,13 @@
* [Laravel](frameworks/laravel.md)
* [Symfony](frameworks/symfony.md)

## Deprecated

* [DOTNET](deprecated/dotnet/README.md)
* [Crypto](deprecated/dotnet/crypto/README.md)
* [API Documentation](deprecated/dotnet/crypto/api-documentation.md)
* [Examples](deprecated/dotnet/crypto/examples.md)
* [Client](deprecated/dotnet/client/README.md)
* [API Documentation](deprecated/dotnet/client/api-documentation.md)
* [Examples](deprecated/dotnet/client/examples.md)

52 changes: 21 additions & 31 deletions c++/complementary-examples.md
Expand Up @@ -28,15 +28,15 @@ git clone https://github.com/arkecosystem/cpp-crypto

### Project Layout

>```text
>project
>- extern/
> ```text
> project
> - extern/
> - cpp-client/
> - cpp-crypto/
>- src/
> - src/
> - | main.c
>- | CMakeLists.txt
>```
> - | CMakeLists.txt
> ```
### Cloning

Expand All @@ -49,32 +49,31 @@ git clone https://github.com/arkecosystem/cpp-crypto extern/cpp-crypto

#### `CMakeLists.txt`

>```cmake
>cmake_minimum_required(VERSION 3.2)
> ```text
> cmake_minimum_required(VERSION 3.2)
>
>project(ark_cpp_example_project)
> project(ark_cpp_example_project)
>
>set(CMAKE_CXX_STANDARD 11)
> set(CMAKE_CXX_STANDARD 11)
>
>if (MSVC)
> if (MSVC)
> add_definitions(
> -D_CRT_SECURE_NO_WARNINGS
> -D_SCL_SECURE_NO_WARNINGS
> -DNOMINMAX
> )
> set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /utf-8")
>endif()
> endif()
>
>add_subdirectory(extern/cpp-client)
>add_subdirectory(extern/cpp-crypto)
> add_subdirectory(extern/cpp-client)
> add_subdirectory(extern/cpp-crypto)
>
>set(FILE_SRC src/main.cpp)
> set(FILE_SRC src/main.cpp)
>
>add_executable(${PROJECT_NAME} ${FILE_SRC})
> add_executable(${PROJECT_NAME} ${FILE_SRC})
>
>target_link_libraries(${PROJECT_NAME} ark_cpp_client ark_cpp_crypto)
>
>```
> target_link_libraries(${PROJECT_NAME} ark_cpp_client ark_cpp_crypto)
> ```
### Building and Running the Project

Expand Down Expand Up @@ -251,7 +250,6 @@ The vendorField is optional and limited to a length of 255 characters. It can be
## Creating and Broadcasting a Second Signature Registration Transaction
```cpp
#include <iostream>
#include <arkClient.h>
Expand Down Expand Up @@ -314,7 +312,6 @@ int main() {
## Creating and Broadcasting a Delegate Registration Transaction

```cpp

#include <iostream>

#include <arkClient.h>
Expand Down Expand Up @@ -373,7 +370,6 @@ int main() {
## Creating and Broadcasting a Vote Transaction
```cpp
#include <iostream>
#include <arkClient.h>
Expand Down Expand Up @@ -438,13 +434,12 @@ int main() {
```

{% hint style="info" %}
Note the **plus (1)** prefix for the public key that is passed to the **.votes()** function. This prefix denotes that this is a transaction to remove a vote from the given delegate.
Note the **plus \(1\)** prefix for the public key that is passed to the **.votes\(\)** function. This prefix denotes that this is a transaction to remove a vote from the given delegate.
{% endhint %}

## Creating and Broadcasting an Unvote Transaction

```cpp

#include <iostream>

#include <arkClient.h>
Expand Down Expand Up @@ -512,13 +507,12 @@ int main() {
```
{% hint style="info" %}
Note the **minus (0)** prefix for the public key that is passed to the **.votes()** function. This prefix denotes that this is a transaction to add a vote to the given delegate.
Note the **minus \(0\)** prefix for the public key that is passed to the **.votes\(\)** function. This prefix denotes that this is a transaction to add a vote to the given delegate.
{% endhint %}
## Creating and Broadcasting an Ipfs Transaction
```cpp
#include <iostream>
#include <arkClient.h>
Expand Down Expand Up @@ -581,7 +575,6 @@ int main() {
## Creating and Broadcasting a Multi Payment Transaction

```cpp

#include <array>
#include <vector>

Expand Down Expand Up @@ -670,7 +663,6 @@ int main() {
## Creating and Broadcasting a Delegate Resignation Transaction
```cpp
#include <iostream>
#include <arkClient.h>
Expand Down Expand Up @@ -733,7 +725,6 @@ A delegate resignation has to be sent from the delegate wallet itself to verify
## Creating and Broadcasting a Htlc Lock Transaction

```cpp

#include <iostream>

#include <arkClient.h>
Expand Down Expand Up @@ -799,7 +790,6 @@ int main() {
## Creating and Broadcasting a Htlc Claim Transaction
```cpp
#include <iostream>
#include <arkClient.h>
Expand Down Expand Up @@ -870,7 +860,6 @@ The **unlockSecret** has to be a SHA256 hash of the plain text secret that you s
## Creating and Broadcasting a Htlc Refund Transaction

```cpp

#include <iostream>

#include <arkClient.h>
Expand Down Expand Up @@ -929,3 +918,4 @@ int main() {
return 0;
}
```
16 changes: 16 additions & 0 deletions deprecated/dotnet/README.md
@@ -0,0 +1,16 @@
# DOTNET

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

.NET framework can be downloaded [here](https://dotnet.microsoft.com/download).

{% hint style="info" %}
For further information on how to install .NET on your operating system:

* [Windows guide](https://dotnet.microsoft.com/learn/dotnet/hello-world-tutorial/intro?initial-os=windows)
* [Unix guide](https://dotnet.microsoft.com/learn/dotnet/hello-world-tutorial/intro?initial-os=linux)
* [macOS guide](https://dotnet.microsoft.com/learn/dotnet/hello-world-tutorial/intro?initial-os=macos)
{% endhint %}

Expand Up @@ -6,6 +6,10 @@ description: .NET Client Library For Communicating With Core Server Public REST

# Client

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

## NuGet Package Manager

> NuGet is the package manager for .NET. The NuGet client tools provide the ability to produce and consume packages. The NuGet Gallery is the central package repository used by all package authors and consumers.
Expand Down
Expand Up @@ -5,6 +5,10 @@ title: API Documentation

# API Documentation

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

## ArkEcosystem.Client.API.Api

### `Api()`
Expand Down
Expand Up @@ -5,6 +5,10 @@ title: Examples

# Examples

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

## Initialization

```csharp
Expand Down
Expand Up @@ -5,6 +5,10 @@ title: Getting Started

## .NET installation

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

.NET framework can be downloaded [here](https://dotnet.microsoft.com/download).

For further information on how to install .NET on your operating system :
Expand Down
Expand Up @@ -6,6 +6,10 @@ description: .NET Crypto Library For Working With Transactions

# Crypto

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

## NuGet Package Manager

> NuGet is the package manager for .NET. The NuGet client tools provide the ability to produce and consume packages. The NuGet Gallery is the central package repository used by all package authors and consumers.
Expand Down
Expand Up @@ -5,6 +5,10 @@ title: API Documentation

# API Documentation

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

## ArkEcosystem.Crypto.Configuration.Fee

### `Get()`
Expand Down
Expand Up @@ -5,6 +5,10 @@ title: Examples

# Examples

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

## Initialization

```csharp
Expand Down
Expand Up @@ -5,6 +5,10 @@ title: Getting Started

## .NET installation

{% hint style="danger" %}
WARNING! This package is deprecated and is no longer maintained and supported.
{% endhint %}

.NET framework can be downloaded [here](https://dotnet.microsoft.com/download).

For further information on how to install .NET on your operating system :
Expand Down

0 comments on commit 0eca7ac

Please sign in to comment.