Cryptum-sdk NPM

Table of Contents
About The Project
First Steps
- Get API Keys
- Requirements
- Installation
- How To's
  - Configuration
  - Blockchain queries
  - Wallets
  - Chainlink
  - Tokens (ERC20)
  - NFTs
  - 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 integrate your JavaScript code with Cryptum's backend through simple function calls that do all the heavy lifting for you.

The Cryptum infrastructure allows clients to integrate and interact with the most diverse blockchain protocols - you don't need to start from scratch! We already laid the foundation for you to build upon.

Don't worry about deploying and maintaining a node, our SDK connects directly with the nodes maintained by Cryptum. Learn more about Cryptum here.

The Cryptum SDK also integrates Chainlink functionality natively, empowering developers with secure and reliable decentralized oracle services. Read more about the Chainlink integration.

First Steps

📁Creation of Projects and 🔑 API Keys

This step is essential, when you start your Cryptum journey. You need to create your account and start a Project on our DASHBOARD. This Project will offer you an API Key, which will be used in all your Cryptum implementations.

Create your account on Cryptum Dashboard

Click on the "Create First Project" button to start creating your new Development Project and get an API Key!

Give your Project a Name (customer name, product or something that refers to what will be developed) and the Project Description. Finally, choose the Development Project Type and click "Next".

For Development projects, you must define which plan will be used. Also choose which blockchain environment you want to access: Free Testnet (only simulation on test networks) or Free Mainnet (Production, with real use of crypto values). Finally, your Project will have been created and you will receive a valid API Key. Then go to the project and start developing!

After you have created your Project, you will be able to use your API Key.

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.

Example

To see the SDK implemented in a sample project, visit the cryptum-lottery project and see it in action

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.

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