Mquark-sdk NPM

SDK User Guide

The inital alpha version of mQuark SDK! You can saved yourself hours of work by bootstrapping your entitys with mQuark SDK. Let’s get you oriented with what’s here and how to use it.

This SDK helps you with submitting your NFT metadata to IPFS and interact with the smart contracts more easily.
More features will be added , checkout the mQuark docs for additional information about the protocol and how to integrate with the smart contracts.

Please provide your feedbacks for our alpha SDK to our dev team member at:

dev@unbounded.vision

Installation

npm i mquark-sdk

SDK Developement Guide

Available Services

Registry Service
Entity Service
Collection Service
Subscriptions Service
IPFS Service
GraphQL API Service

Utility Functions

Merkle Proof Generator
Signature Generator

Registry Service

The Registry Service is used to interact with the mQuark Registry smart contract. It provides the following functions:

registerEntity
getLastEntityId
getEntitySubscriptionPrice
getRegisteredEntity
getSubscriber
getController
getImplementation
getEntityAddress
getEntityId
getEntityIsRegistered

Entity Service

The Entity Service is used to interact with the mQuark Entity smart contract. It provides the following functions:

createCollection
importExternalCollection
transferOwnershipOfCollection
collectFunds
withdraw
getEntityInfo
getBalance
getLastCollectionId
getCollectionAddress

Collection Service

The Collection Service is used to interact with the mQuark Collection smart contract. It provides the following functions:

mint
airdropMint
airdropBatchMint
mintBatch
airdropSubscriptionMint
airdropBatchSubscriptionMint
subscriptionMint
transferOwnership
getOwnerBalance
getProtocolBalance
getCollectionInfo
tokenEntityURI
tokenURI

Subscriptions Service

The Subscriptions Service is used to interact with the mQuark Subscriptions smart contract. It provides the following functions:

subscribeToEntity
updateURISlot
directUpdateURISlot
directUpdateURISlots
unlockToken
transferTokenEntityURI
setDefaultURI
withdraw
withdrawProtocol
getIsAddressRegisteredAsEntity
getEntityBalance
getEntityConfig
getIsUnlocked
getIsSubscribed
getCollection
calculateBatchSubscriptionPrice

IPFS Service

pinJSONToIPFS
pinFileToIPFS

GraphQL API Service

fetch_entity
fetch_entity_collections
fetch_entity_collection
fetch_all_entities
fetch_quark_owner
fetch_token
fetch_templates
fetch_collections_balance
fetch_contracts
fetch_controller
fetch_implementation
fetch_imported_collections
fetch_registry
fetch_subscriber

Conculsion

The SDK is still in alpha version, more features will be added in the future. Please provide your feedbacks to our dev team member at: dev@unbounded.vision It now supports mQuarkV2 NFT Implementations, they are brand new and brings new and extended functionalities. Checkout the mQuark docs for additional information about the protocol and how to integrate with the smart contracts. You're more than welcome to implement your own SDK and share it with the community.