Table of Contents

• Table of Contents
• About The Project
• First Steps
  • Requirements
  • Installation
  • How To's
    • Configuration
    • Blockchain queries
    • Wallets
    • Tokens (ERC20)
      • Ethereum and other EVMs
      • Solana
      • Hathor
      • Stellar
      • Ripple
      • Bitcoin
      • Cardano
    • NFTs
      • Ethereum and other EVMs
      • Solana
      • Hathor
    • Smart contracts
      • Loot boxes
    • Prices
    • Swap tokens
    • Webhooks
    • Staking
• Contributing
  • What does my PR need to be accepted ?
• License
• Contact

About The Project

This project provides a handy way to integrage your JavaScript code with Cryptum's backend through simple function calls that do all the heavy lifting for you. Learn more about Cryptum here.

First Steps

Requirements

• NPM
• Node version: ^14.17.0

Installation

Open your project

cd my-amazing-project/

Install using npm manager or yarn

npm install -S cryptum-sdk

yarn add cryptum-sdk

How To's

Below is a short code example showing how you can use cryptum-sdk to connect your amazing application with several blockchains.

Configuration

To configure cryptum-sdk you need only to provide a config in format JSON.

const CryptumSDK = require('cryptum-sdk')

const sdk = new CryptumSDK({
  enviroment: 'development', // 'testnet' or 'development', 'mainnet' or 'production'
  apiKey: 'my-secret-api-key',
})

For more in-depth examples check the docs/ folder and our guides here.

Contributing

Contributions are what make the open source community an incredible place to learn, inspire and create. Any contribution you make will be much appreciated.

1. Fork the project
2. Create a Branch for your feature (git checkout -b feature/amazing-feature)
3. Insert your changes (git add .)
4. Make a commit with your changes (git commit -m 'feat(<folder-name>): Inserting a Amazing Feature !)
5. Push the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

What does my PR need to be accepted ?

In order for us to accept your PR, you need to adhere to the following standards.

1. Create using the code pattern currently used in cryptum-sdk
2. Test your update and show artifacts in PR.

That's it 🤷🏻‍♂️

License

Distributed under the MIT license. See LICENSE for more information.

Contact

Blockforce - SITE - [email protected]