Skip to content
This repository has been archived by the owner on Dec 29, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hacker-volodya authored Dec 29, 2023
1 parent 11b022c commit d045f4e
Showing 1 changed file with 2 additions and 64 deletions.
66 changes: 2 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,64 +1,2 @@
## πŸ’Ž ton3-core

[![npm](https://img.shields.io/npm/v/ton3-core)](https://www.npmjs.com/package/ton3-core)
![GitHub top language](https://img.shields.io/github/languages/top/tonstack/ton3-core)
[![Coverage Status](https://coveralls.io/repos/github/tonstack/ton3-core/badge.svg?branch=main)](https://coveralls.io/github/tonstack/ton3-core?branch=main)
[![TON](https://img.shields.io/badge/based%20on-The%20Open%20Network-blue)](https://ton.org/)

ton3-core is a core package of ton3 inspired by [tonweb](https://github.com/toncenter/tonweb) to work with [TON blockchain](https://ton.org).\
Visit [documentation](./docs/) to see API reference.
> :warning: Work in progress, API can (and most likely will) be changed! This is not production ready version yet.
## How to install
```
npm i ton3-core
```

## Simple usage
```typescript
import { BOC, Builder, Mnemonic } from 'ton3-core'

const mnemonic = new Mnemonic()

console.log(mnemonic.words) // prints mnemonic phrase
console.log(mnemonic.keys.private) // prints private key
console.log(mnemonic.keys.public) // prints public key

const text = 'Hello, World!'
const cell = new Builder()
.storeString(text)
.cell()

const boc = BOC.toBytesStandard(cell)
const result = BOC.fromStandard(boc)
.parse()
.loadString()

console.log(text === result) // true
```

## Features and status

| Feature | Status |
|---------------------------------------------|-------- |
| BOC ordinary/exotic (de)serialization | βœ… |
| Builder, Cell, Slice | βœ… |
| Hashmap (dictionary) (de)serialization | βœ… |
| HashmapE (dictionary) (de)serialization | βœ… |
| Mnemonic/keypair BIP39 standard | βœ… |
| Mnemonic/keypair TON standard | βœ… |
| Coins (class for TON, JETTON, e.t.c.) | βœ… |
| Address (class for TON address) | βœ… |
| Message layouts (such as MessageX e.t.c.) | βœ… |
| Contracts (abstract TON contract class) | βœ… |
| ~100% tests coverage | ❌ |

## Donations
You can support library author by sending any amount of TON to address below
```
UQCcJpog-XAzY7tK6uqCd6QrEBlgocPXdXgIG3ev1Dxg5dl2
```

## License

MIT License
# Deprecation notice
>⚠️ Repo was moved to [tonkite](https://github.com/tonkite/ton3-core) organization.

0 comments on commit d045f4e

Please sign in to comment.