# concurrentlib

> concurrent Smart Contract library for Solidity

Latest version **2.0.0** (published 2024-02-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install concurrentlib
pnpm add concurrentlib
yarn add concurrentlib
bun add concurrentlib
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2024-02-04 |
| First published | 2023-09-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 113.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Arcology Network |
| Maintainers | sameplace |
| Keywords | parallel execution, solidity, evm, ethereum, smart contracts, arcology network, rollup, l2 |

## Links

- npm: https://www.npmjs.com/package/concurrentlib
- Repository: https://github.com/arcology-network/concurrentlib
- Homepage: https://arcology.network/
- Issues: https://github.com/arcology-network/concurrentlib/issues
- npm.io page: https://npm.io/package/concurrentlib

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2024-02-04
- 1.0.1 — 2023-09-14
- 1.0.0 — 2023-09-14

## README

<div align="left">
  <img src="./img/arcology-logo-text-dark-transparent.svg" alt="Your Image Alt Text" height="120px" align="center"/>
</div>

<h1> Concurrent APIs <img align="center" height="32" src="./img/code-file.svg">  </h1>

Solidity, the programming language used to develop smart contracts on the Ethereum platform, was not initially designed for concurrent use, so it does not include the features and capabilities necessary for efficient concurrent programming. 

[Arcology Network](https://arcology.network) offers a suite of Solidity APIs customized for concurrent programming tasks. This package includes the Solidity APIs for  smart contract developers to fully utilize the power of **Arcology's parallel execution** capabilities. 

>>Please be aware that all the libraries in the package are specifically designed for Arcology Network only.

<h2> Installation <img align="center" height="32" src="./img/cloud-download.svg">  </h2>

``` shell
$ npm install arcologynetwork/concurrentlib
```

<h2> Usage <img align="center" height="32" src="./img/ruler-cross-pen.svg">  </h2>

Once installed, you can use the contracts in the library by importing them.

### Example

The following example demonstrates how to use the concurrentlib to parallelize a simple smart contract. Arcology has a set of concurrent data structures and variables that allow concurrent manipulations. Below is an example of that. 

#### Simple Contract

The following example of a simple smart contract that allows users to like a post. A simplest version of the contract is shown below. When a calls the `like()` function, the `likes` of the receiver is incremented by 1.

This implementation doesn't support concurrent execution. If multiple users call the `like()` function concurrently, the `likes` of the receiver will be incremented concurrently. This is not allowed in Solidity.

```solidity
contract Like {
    uint public likes;

    function like() public {
        likes += 1;
    }    
}
```

#### Parallelized Version

In the parallelized version, the `likes` is replaced with a `U256Cumulative` variable from the `arcologynetwork/contracts/concurrentlib/commutative/U256Cum.sol` library. The variable allows concurrent increment and decrement operations. Now, the `like()` function can be called concurrently by multiple users.

```solidity
import "arcologynetwork/contracts/concurrentlib/commutative/U256Cum.sol";

contract Like {
    U256Cumulative public likes;

    function like() public {
        likes.add(1);
    }    
}
```

<h2> Learn More  <img align="center" height="32" src="./img/info.svg">  </h2>

You can find more examples in the [developer's guide](https://doc.arcology.network/arcology-concurrent-programming-guide/).

<h2> License  <img align="center" height="32" src="./img/copyright.svg">  </h2>

Arcology's concurrent lib is released under the MIT License.

<h2> Disclaimer  <img align="center" height="32" src="./img/warning.svg">  </h2>

Arcology's concurrent lib is made available under the MIT License, which disclaims all warranties in relation to the project and which limits the liability of those that contribute and maintain the project. You acknowledge that you are solely responsible for any use of the Contracts and you assume all risks associated with any such use.

---
_Source: https://npm.io/package/concurrentlib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._