search

spknetwork / honeycomb-spkcc

MIT License
4 stars 18 forks source link

readme

HoneyComb

This is a Decentralized Autonomous Organization built on the HIVE ecosystem.

THIS BUILD IS PASSING BUT SEVERAL FEATURES ARE UNTESTED. DO NOT RECOMMEND USING ON ACCOUNT WITH HIGH BALANCES

This software builds a network of peers that use HIVE to post and interpret transactions. This allows these peers to come to a consensus and elect peers to run tasks. Distributing computing in this way allows a vast amount of potential applications, DeFi, and oracle services. By distributing authority to perform transactions we can have a frictionless(no intermediate tokens, no central authority, no intrinsic fees) way to cross asset boundaries(HIVE/COMB) with no information asymmetries, ie Finance without securities by definition... just free speech: As no party is required to perfom any function, or prevented from performing any function, no promises are made by peers. Network Incentives (COMB) alone are enough to maintain trust.

These features are currently working and being tested for 0.9.0a:

These features are works in progress:

This software is meant to be run as a public API for decentralized token data.

While it runs it verifies other nodes are operating correctly and confirms this by posting a customJson transaction to Hive. 288(configurable) messages will be required per day per node operator. More Resource Credits will be required to handle escrow transactions and transfers.

Deploy from heroku or similar and set ENV variables with a hive name and active key. Deploy from home computer for maximum account security.

Running A Node

Prerequisites

Server Installation

Detailed Instructions also at /docs/setup.md Which include Docker and IPFS linking

git clone https://github.com/3speaknetwork/honeycomb-spkcc.git

cd honeycomb-spkcc

nano .env or your favorite editor

account="hiveaccount"
active=5JactivePrivateKey
msowner=5KadditionalPrivateKey
mspublic=STMpublickey

npm install

npm start

Recommendations

Cloud Installation

account=hiveaccount

active=hiveactivekey

To Build Your Own Token

Branch this and find this part of config.js

TOKEN CONFIGS -- ALL COMMUNITY RUNNERS NEED THESE SAME VALUES

const starting_block = 49988008; //from what block does your token start

const prefix = 'dlux_' //Community token name for Custom Json IDs

const TOKEN = 'DLUX' //Token name

const tag = 'dlux' //https://the-front-end.com/`tag`/@`leader`/`permlink`

const jsonTokenName = 'dlux' //what customJSON in Escrows and sends is looking for

const leader = 'dlux-io' //Default account to pull state from, will post daily

const ben = 'dlux-io' //Account where comment benifits trigger token action

const delegation = 'dlux-io' //account people can delegate to for rewards

const msaccount = 'dac.escrow' //account controlled by community leaders

const mainAPI = 'token.dlux.io' //leaders API probably

const mainFE = 'dlux.io' //frontend for content

const mainIPFS = 'a.ipfs.dlux.io' //IPFS service

const mainICO = 'robotolux' //Account collecting ICO HIVE

Then alter the state.js with balances and other starting information

Fungible Token and Non-Fungible Token (NFT) Operations

DLUX offers a decentralized protocol for minting and trading NFT's. These tokens can be minted, auctioned, transferred, sold, bought, held in escrow, bid on, or deleted.

Actions Available

SPK Actions 1.1

Power Larynx

This action will move your LARYNX into a locked state. These tokens can now be delegated to nodes running services. To unlock them for sale or transfer will take 4 weeks, in 4 equal parts, 1 at the end of each week.

Params


[
    "custom_json",
    {
      "required_auths": [
        YOUR_HIVE_ACCOUNT
      ],
      "required_posting_auths": [],
      "id": "spkcc_power_up",
      "json": "{\"amount\":1}" // in millitokens => 0.001 LARYNX is 1. 1 LARYNX is 1000
    }
  ]

Delegate Larynx Power

Delegating LARYNX earned both your account and the receiver an account an equal amount. 50% higher than if you power up alone. To remove delegation to an account simply set the amount to 0

Params


[
    "custom_json",
    {
      "required_auths": [
        YOUR_HIVE_ACCOUNT
      ],
      "required_posting_auths": [],
      "id": "spkcc_power_grant",
      "json": "{\"to\":VALID_NODE_SERVICE_ACCOUNT,\"amount\":1}" // in millitokens => 0.001 LARYNX is 1. 1 LARYNX is 1000
    } // Transaction will fail if to is not a currently registered service provider
  ]

Send SPK

Send earned SPK to a hive account. Ensure account is valid before send. Tokens can not be recovered.

Params


[
    "custom_json",
    {
      "required_auths": [
        YOUR_HIVE_ACCOUNT
      ],
      "required_posting_auths": [],
      "id": "spkcc_spk_send",
      "json": "{\"to\": VALID_HIVE_ACCOUNT,\"amount\":1}" // amount in millitokens => 0.001 LARYNX is 1. 1 LARYNX is 1000
    }
  ]

NFT (non-fungible token) Actions

NFT Transfer (id: dlux_nft_transfer)

This action transfers an NFT from one wallet to another.

params:

example:

json:{ set: 'dlux', uid: 'aa', to: 'somebody' }

NFT Reserve Transfer (id: dlux_nft_reserve_transfer)

This action builds a token escrow contract with payment price and expiration. Seller uses this action to create a contract for specific wallet to pay for and receive the NFT. As opposed to listing it publicly on the market which would allow any buyer to buy the token.

params:

example:

json:{ set: 'dlux', uid: 'aa', to: 'somebody', price: 1000 // 1.000 DLUX }

NFT Reserve Complete (id: dlux_nft_reserve_complete)

This action fulfills an NFT escrow transfer via complete payment. Recipient of NFT uses this action to complete the contract and receive the NFT. If successfully, the price defined in the contract will be deducted from the wallet.

params:

example:

json:{ set: 'dlux', uid: 'aa' }

NFT Transfer Cancel (id: dlux_nft_transfer_cancel)

This action cancels an NFT transfer escrow contract.

params:

example:

json:{ set: 'dlux', uid: 'AA' }

NFT Delete (id: dlux_nft_delete)

This action will permanently delete an NFT. Cannot be undone. Changes NFT's owner to D.

params:

example:

json:{ set: 'dlux', uid: 'AA' }

NFT Define (id: dlux_nft_define)

This action defines a new NFT set.

params:

example:

json: { "name":"dlux", "type": 1, "script": "QmPsxgySUZibuojuUWCMQJpT2uZhijY4Cf7tuJKR8gpZqq", // see example below "permlink": "disregardfiat/nft-announcement", "start": "00", "end": "==", // 4,096 unique mints for this set "royalty": 100, "handling": "svg", "max_fee": 10000000, "bond": 1000, //A burn value that can be preloaded into the contract }

script example:

//<html><head><script>
function compile (message, display) {
const colors = ['#000000', '#AA0000', '#00AA00', '#AA5500', '#0000AA', '#AA00AA', '#00AAAA', '#AAAAAA', '#555555', '#FF5555', '#55FF55', '#FFFF55', '#5555FF', '#FF55FF', '#55FFFF', '#FFFFFF']
const Base64 = {
    _Rixits :
    "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+=",
    toFlags : function (rixits) {
        var result = []
        rixits = rixits.split('');
        for (j = 0; j < rixits.length; j++) {
            for (var i = 32; i >= 1; i = i/2){
                if (this._Rixits.indexOf(rixits[j]) >= i){
                    result.unshift(1)
                    rixits[j] = this._Rixits[this._Rixits.indexOf(rixits[j]) - i]
                } else {
                    result.unshift(0)
                }
            }
        }
        return result
    }
} 
        const flags = Base64.toFlags(message)
        var uColors = []
        var picker = 0
        for(var i = 0; i < 3; i++){
            for(var j = 0; j < 4; j++){
                if(flags[i*4 + j]){
                    picker += Math.pow(2,j)
                }
            }
            uColors.push(colors[picker])
            picker = 0
        }
        const SVG = '<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 333 333"><defs><style>.cls-1{fill:#393d49;}.cls-2' + uColors[0].replace('#', '') + '{fill:' + uColors[0] + ';}.cls-3' + uColors[1].replace('#', '') + '{fill:' + uColors[1] + ';}.cls-4' + uColors[2].replace('#', '') + '{fill:' + uColors[2] + ';}</style></defs><rect class="cls-1" width="333" height="333" rx="33.3"/><polygon class="cls-2' + uColors[0].replace('#', '') + '" points="180.51 142.86 180.22 142.86 123.17 46.14 207.53 44.57 214.82 56.49 144.19 57.9 151.11 69.33 165.81 93.63 180.52 117.94 187.66 129.75 201.54 129.74 229.98 129.74 257.94 129.74 271.94 129.74 236.41 68.54 249.57 68.67 292.68 142.08 180.51 142.86"/><polygon class="cls-3' + uColors[1].replace('#', '') + '" points="123.17 46.14 180.22 142.86 180.51 142.86 173.73 154.38 173.48 154.38 116.46 58.51 123.17 46.14"/><polygon class="cls-4' + uColors[2].replace('#', '') + '" points="180.06 68.94 151.11 69.33 144.19 57.9 214.82 56.49 180.52 117.94 173.07 105.61 193.51 68.76 180.11 68.94 180.06 68.94"/><polygon class="cls-2' + uColors[0].replace('#', '') + '" points="81.49 69.81 95.22 69.9 152.32 166.28 137.95 166.24 81.49 69.81"/><polygon class="cls-3' + uColors[1].replace('#', '') + '" points="103.73 203.78 117.29 178.81 123.88 166.69 116.86 154.7 102.5 130.16 88.38 106.03 81.31 93.94 46.42 155.51 39.89 144.09 81.49 69.81 137.95 166.24 84.27 264.56 40.32 192.55 46.93 180.23 83.81 240.48 90.18 228.75 103.73 203.78"/><polygon class="cls-3' + uColors[1].replace('#', '') + '" points="180.11 68.94 193.51 68.76 173.07 105.61 180.52 117.94 165.81 93.63 180.06 68.94 180.11 68.94"/><polygon class="cls-3' + uColors[1].replace('#', '') + '" points="201.54 129.53 236.29 68.47 236.41 68.54 271.94 129.74 257.94 129.74 257.94 129.68 243.57 105.23 236.13 92.56 215.68 129.32 201.54 129.53"/><polygon class="cls-4' + uColors[2].replace('#', '') + '" points="81.31 93.94 88.38 106.03 88.33 106.06 74.48 130.81 67.31 143.63 109.36 142.71 116.68 154.81 46.42 155.66 46.42 155.51 81.31 93.94"/><polygon class="cls-4' + uColors[2].replace('#', '') + '" points="236.13 92.56 243.57 105.23 243.35 105.36 229.98 129.25 229.98 129.74 201.54 129.74 201.54 129.53 215.68 129.32 236.13 92.56"/><polygon class="cls-2' + uColors[0].replace('#', '') + '" points="102.5 130.16 116.86 154.7 116.68 154.81 109.36 142.71 67.31 143.63 74.48 130.81 74.71 130.93 102.07 130.41 102.5 130.16"/><polygon class="cls-4' + uColors[2].replace('#', '') + '" points="173.73 154.38 180.51 142.86 292.68 142.08 285.67 153.89 173.73 154.38"/><polygon class="cls-4' + uColors[2].replace('#', '') + '" points="137.95 166.24 152.32 166.28 152.47 166.52 98.34 264.11 84.27 264.56 137.95 166.24"/><polygon class="cls-2' + uColors[0].replace('#', '') + '" points="75.22 203.95 90.18 228.75 83.81 240.48 46.93 180.23 117.29 178.81 110.41 191.47 68.27 192.43 75.2 203.91 75.22 203.95"/><polygon class="cls-4' + uColors[2].replace('#', '') + '" points="117.29 178.81 103.73 203.78 75.22 203.95 75.2 203.91 68.27 192.43 110.41 191.47 117.29 178.81"/><polygon class="cls-2' + uColors[0].replace('#', '') + '" points="173.73 178.97 284.69 177.27 293.11 190.05 181.29 191.19 173.73 178.97 173.73 178.97"/><polygon class="cls-3' + uColors[1].replace('#', '') + '" points="173.45 178.98 173.73 178.97 173.73 178.97 181.29 191.19 125.66 288.43 118.67 276.21 173.45 178.98"/><polygon class="cls-4' + uColors[2].replace('#', '') + '" points="230.69 203.13 216.31 203.23 202.17 203.32 188.28 203.42 181.41 215.38 167.24 240.01 153.07 264.63 146.42 276.21 217.06 276.06 210.03 288.14 125.66 288.43 181.29 191.19 293.11 190.05 251.53 263.12 238.38 263.54 272.65 202.84 257.89 202.95 230.69 203.13"/><polygon class="cls-3' + uColors[1].replace('#', '') + '" points="202.17 203.32 216.31 203.23 237.56 239.53 244.7 226.68 257.89 202.95 272.65 202.84 238.38 263.54 238.25 263.61 202.17 203.32"/><polygon class="cls-2' + uColors[0].replace('#', '') + '" points="216.31 203.23 230.69 203.13 244.5 226.57 244.7 226.68 237.56 239.53 216.31 203.23"/><polygon class="cls-3' + uColors[1].replace('#', '') + '" points="167.24 240.01 181.41 215.38 174.24 227.88 195.49 264.27 182.08 264.38 182.03 264.38 167.24 240.01"/><polygon class="cls-2' + uColors[0].replace('#', '') + '" points="182.03 264.38 182.08 264.38 195.49 264.27 174.24 227.88 181.41 215.38 217.06 276.06 146.42 276.21 153.07 264.63 182.03 264.38"/></svg>'

        if(display){
            document.getElementById('body').innerHTML = SVG
        } else {
            return {HTML:SVG, attributes:[{name:'Color 1', value: uColors[0]},{name:'Color 2', value: uColors[1]},{name:'Color 3', value: uColors[2]}], sealed:''}
        }

}
//</script>
/*
//<script>
if (window.addEventListener) {
    window.addEventListener("message", onMessage, false);
    }
    else if (window.attachEvent) {
    window.attachEvent("onmessage", onMessage, false);
    }
    function onMessage(event) {
    var data = event.data;
    if (typeof(window[data.func]) == "function") {
    const got = window[data.func].call(null, data.message);
    window.parent.postMessage({
        'func': 'compiled',
        'message': got
        }, "*");
    }
    }
function onLoad(id){
    window.parent.postMessage({
        'func': 'loaded',
        'message': id
        }, "*");
}
//</script>
*/
//</head>
//<body id="body">Append ?NFT_UID to the address bar to see that NFT. "...html?A6"<script>const uid = location.href.split('?')[1]; if(uid){compile(uid, true)}else{onLoad(uid)}</script></body></html>

The script should return: {HTML:SVG, attributes:[{name:'Color 1', value: uColors[0]},{name:'Color 2', value: uColors[1]},{name:'Color 3', value: uColors[2]}], sealed:''} HTML, which may include Base64 Imgs, GTLF, etc... plus an array of attributes, and optionally a sealed picture

NFT Mint (id: dlux_nft_mint)

This action mints a new NFT

params:

example:

json:{ set: "dlux" }

NFT Auction (id: dlux_nft_auction)

This action lists an NFT for auction on the market. Temporarily changes owner to 'ah'.

params:

example:

json:{ set: 'dlux', uid: 'AA', price: 1000, // 1.000 DLUX now: 10000, // not implemented time: 7 //integer days }

NFT Auction bidding (id: dlux_nft_bid)

This action makes a bid for an active NFT action

params:

example:

json:{ set: 'dlux', uid: 'AA', bid_amount: 1000 }

NFT Sell (id: dlux_nft_sell)

This lists an NFT for sale on the market.

params:

example:

json:{ set: 'dlux', uid: 'AA', price: 1000 // 1.000 DLUX }

NFT Market Buy (id: dlux_nft_buy)

params:

example:

json:{ set: 'dlux', uid: 'AA', price: 1000 // 1.000 DLUX }

NFT Sell Cancel (id: dlux_nft_sell_cancel)

This action cancels an NFT market sale listing

params:

example:

json:{ set: 'dlux', uid: 'AA' }

FT (fungible token) Actions

Similar to NFTs, DLUX offers a decentralized protocol for creating and trading NFT's. These tokens can be airdropped, auctioned, transferred, sold, bought, held in escrow, or bid on.

FT Transfer (id: dlux_ft_transfer)

This action transfers a FT from wallet to wallet.

params:

example:

json:{ set: 'dlux', to: 'somebody' }

FT Airdrop (id: dlux_ft_airdrop)

This action airdrops tokens to a list of wallets.

params:

example:

json:{ set: 'dlux', to: ['somebody','someother'] }

FT Escrow (id: dlux_ft_escrow)

This action creates escrow contract for a token.

params:

example:

Not implemented

FT Escrow Complete (id: dlux_ft_escrow_complete)

This action completes escrow for a token.

params:

example:

Not implemented

FT Escrow Cancel (id: dlux_ft_escrow_cancel)

This action cancels escrow for a token.

params:

example:

Not implemented

FT Sell (id: dlux_ft_sell)

This action lists a token for sale on the market.

params:

example:

Not implemented

FT Buy (id: dlux_ft_buy)

This action places a buy order for token on the market.

params:

examples:

Not implemented

FT Sell Cancel (id: dlux_ft_sell_cancel)

This action cancels the sale for a token on the market.

params:

examples:

Not implemented

FT Auction (id: dlux_ft_auction)

This action lists a token up for action.

params:

example:

Not implemented

FT Bid (id: dlux_ft_bid)

This action enters an auction bid for a token.

params:

example:

Not implemented