Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

zenzo-sdk-nodejs

1.1.0 • Public • Published

ZENZO Node.js SDK

JavaScript Style Guide

Notice: This module and API is in early development and may change in the future.

ZENZO Arcade Official Website

Getting Started

Install the ZENZO NPM Package with:

npm i zenzo-sdk-nodejs

Also, require the module in your Node.js application with:

const ZENZO = require("zenzo-sdk-nodejs")

Using the API

Authentication

To authenticate with the ZENZO SDK, visit the Arcade Dashboard, hit the hidden "Developer Mode" button in the bottom-right of the page and copy your API key under your Deposit box. Throw it into the authenticator method, like the following:

ZENZO.auth("api-key")

Arcade SDK

The Arcade SDK is a partition of the ZENZO SDK that interacts with the Arcade's main service, this can be used for getting or manipulating account-related data, platform statistics, uptime, and more.

Ping

// Ping the Arcade, a response of "Pong!" will come back if the Arcade is alive and well
ZENZO.ping().then(res => {
  console.log(res) // Pong!
})

Regen

ZENZO.regen().then(res => {
  console.log(res.content) // New API Key
})

Forge SDK

The Forge SDK is a partition of the ZENZO SDK that interacts with the Arcade Forge, a service for providing multi-platform, secure and valuable items and content within games. Using the Forge, you can create in-game items that are worth real monetary value, as all Forge items are backed by a specified amount of ZNZ, locked away until the item is either Smelted or Crafted.

The Forge can, for example:

  • Allow gamers to create and introduce truly custom in-game items.

  • Allow gamers to 'own' their items entirely and permanently.

  • Allow game developers to create a network of games where the items within them can be transferred between them, effortlessly.

List

An endpoint that gets an array containing all items owned by the API key's account.

ZENZO.forgelist().then(res => {
  console.log(res.content) // JSON array of items
})

Create

An endpoint that creates a Forge item with a specified value, name and image. The value of the item will be deducted from the API's account balance. If it cannot afford to create an item, an error will be thrown.

ZENZO.forgecreate(10, "ZNZ Kitty", "https://cdn.crowdfundinsider.com/wp-content/uploads/2018/04/CryptoKittie-mascot-Lola.png").then(res => {
  console.log(res.content) // JSON object of the item
})

Smelt

An endpoint that smelts (destroys) a Forge item, the value of the item will be converted back into blockchain ZNZ and added to the API's account balance.

ZENZO.forgesmelt("item-id").then(res => {
  console.log(res.message) // Human-readable response
})

Craft

An endpoint that crafts a new Forge item out of two older Forge items. The new item will have the combined value of both previous items, while the Name and Image can be customized again.

ZENZO.forgecraft("item_one-id", "item_two-id", "crafted-item-name", "crafted-item-image-url").then(res => {
  console.log(res.message) // Human-readable response
  console.log(res.content) // JSON object of the item
})

Transfers

An endpoint that transfers an item from the API's account to another Arcade account.

ZENZO.forgetransfer("item-id", "user-id").then(res => {
  console.log(res.message) // Human-readable response
})

Example Node.js files can be found in the /examples directory within the repository.

Install

npm i zenzo-sdk-nodejs

DownloadsWeekly Downloads

1

Version

1.1.0

License

MIT

Unpacked Size

12.9 kB

Total Files

12

Last publish

Collaborators

  • avatar