This repository has been archived by the owner on Dec 29, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
11b022c
commit d045f4e
Showing
1 changed file
with
2 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |