Javascript SDK for the æternity blockchain
Clone or download
Permalink
Failed to load latest commit information.
.github Add template for Issue creation Nov 13, 2018
bin Remove aeproject from sdk. Migrate to new repo (#131) Nov 8, 2018
docker Epoch 0.25 compatibility Nov 6, 2018
docs Change docs (Cli -> Universal) Nov 16, 2018
es Add keystore tests Nov 16, 2018
examples/connect-two-ae ⚠️ breaking change - Rename `Cli` to `Universal` (#122) Oct 30, 2018
test Add keystore tests Nov 16, 2018
tooling/docs Release 0.18.0-0.1.1 (#73) Jul 31, 2018
.babelrc Release 0.14.0-0.1.0 (#53) Jun 11, 2018
.dir-locals.el Add Emacs IDE support Mar 26, 2018
.editorconfig Feature/wallet aepp rpc (#110) Oct 23, 2018
.env Epoch 0.25 compatibility Nov 6, 2018
.gitignore Add template for Issue creation Nov 13, 2018
.jsdoc.json Release 0.18.0-0.1.0 (#71) Jul 24, 2018
.jsdoc2md.json Release 0.18.0-0.1.0 (#71) Jul 24, 2018
.projectile Release 0.18.0-0.1.0 (#71) Jul 24, 2018
.tern-project Add Emacs IDE support Mar 26, 2018
AUTHORS Prepare first 0.10.0 release Apr 3, 2018
CHANGELOG.md New CHANGELOG and package with correct version (next) Nov 13, 2018
Dockerfile.ci Fix docker node version (#103) Oct 17, 2018
Jenkinsfile Fix docker node version (#103) Oct 17, 2018
LICENSE Release v0.13.0-0.1.0 (#36) May 24, 2018
README.md add hints in docs Oct 19, 2018
apidoc.js Use ES methods instead of Ramda (#120) Nov 6, 2018
concept.png Release 0.18.0-0.1.1 (#73) Jul 31, 2018
docker-compose.yml Release 0.18.0-0.1.0 (#71) Jul 24, 2018
package-lock.json Implement AENS native transaction Nov 14, 2018
package.json Implement AENS native transaction Nov 14, 2018
rename-to-md.js CLI docs (#88) Oct 12, 2018
shrinkwrap.yaml new shrinkwrap including bignumber.js Nov 13, 2018
webpack.config.js Fix build Nov 14, 2018

README.md

aepp-sdk

Build Status npm npm

JavaScript SDK for the revolutionary æternity blockchain, targeting the Epoch implementation.

aepp-sdk is hosted on GitHub.

Concept Drawing of aepp-sdk

Disclaimer

This SDK is at an alpha stage where things easily can break. We aim to make our alpha releases as stable as possible. Neverless it should not be taken as production-ready. To catch up with the more edgy state of development please check out the develop branch.

Usage Documentation

  1. Add the latest @aeternity/aepp-sdk release from npmjs.com to your project using one of these commands
pnpm i @aeternity/aepp-sdk
# or
npm i @aeternity/aepp-sdk
# or
yarn add @aeternity/aepp-sdk

Note: To install a Pre-Release (latest beta or alpha version) using on the latest Epoch version, you have to install the package appending the @next tag reference.

pnpm i @aeternity/aepp-sdk@next
npm i @aeternity/aepp-sdk@next
yarn add @aeternity/aepp-sdk@next

Hint: You can also add a development version from GitHub by dropping the @ and adding # and a branch name at the end, for example pnpm i aeternity/aepp-sdk#develop.

  1. Import the right flavor
import Aepp from '@aeternity/aepp-sdk/es/ae/aepp'
  1. Create an instance
const ae = Aepp()
  1. Start interacting with the blockchain
ae.then(ae => ae.height()).then(h => console.log(h))
  1. IMPORTANT: 🤓 Check out the Usage Documentation to avoid common pitfalls!

Hacking

For advanced use, development versions and to get a deeper understanding of the SDK, it is advised to read the Hacking documentation.

API

Change Log

License

ISC License (ISC) Copyright © 2018 aeternity developers

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.