Changes

Jump to navigation Jump to search
15,547 bytes added ,  00:16, 5 June 2020
{{#seo:
|title=Ravencoin Wiki: CodeDevelopment and Roadmap|keywords=Ravencoin roadmap development code |description=Information targeted at for developers looking to find out more about working with and users interested in the Ravencoin Blockchaindevelopment progress.
}}
=Introduction=This section of the wiki aims to help document the development work done related to the Ravencoin networkand provide information for developers who want to build software and tools using Ravencoin.
Future dev chats will be available Every two weeks developer meetings take place on the Ravencoin Community discord - server #irc-ravencoindevelopment-meetings channel (https://discord.gg/jn6uhur). An archive of the devmeetings is available on Reddit (in the side panel) https://www.reddit.com/r/Ravencoin/.
Historic Several dev chats on IRC, now moved to Discord. Open weekly or fortnightly dev chat on IRC check https://www.ravencointalk.org/post/ravencoin-open-developer-meeting-9816968?pid=1305079154 IRC: https://webchat.freenode.net/?channels=ravencoin-dev Archive of the conversation on the 10th Aug 2018 on Reddit summaries are available at https://www.redditravencoinplatform.com/r/Ravencoin/comments/96at36/irc_log_from_ravencoin_open_developer_meeting_aug/
For Ravencoin network details, see:
* [http://www.ravennodes.com/ Ravennodes.com] for node statistics.
* [https://rvnstats.info/ Ravenstats.info] for mining difficulty, asset, hashrate, supply, block times, and more.
* [https://ravencoin.network/ Ravencoin.network] for transactions, addresses, pool stats, rich list, and more.
* [https://www.ravencoinburn.org/ Ravencoinburn.org] for a quick overview of burned Ravencoin.
=Ravencoin platform development=
 Currently organized and based on Tron his talk at the Ravencoin NH meetup (October 11, 2018): [https://docs.google.com/presentation/d/1hMavh6kYHXBatv-36RCOWeyziypA2CRWoXNk6GDjQy8/edit#slide=id.p] ==Phase 1 - Ravencoin launch & mining algorithm- Jan 3rd, 2018== In addition to the [https://ravencoin.org/wp-content/uploads/2018/03/X16R-Whitepaper.pdf X16R algorithm], most of the core code changes are in [https://github.com/RavenProject/Ravencoin/blob/master/src/chainparams.cpp the chainparams] file.
The details are broken down on the wiki page: '''[[Chainparams]]'''.
It's worth mentioning, whilst we all try to keep these pages up to date, the RavenProject code on GitHub could change and these pages could become out of sync. Please validate on [https://github.com/RavenProject/Ravencoin https://github.com/RavenProject/Ravencoin].
==Phase 2&4 Dark Gravity Wave - AssetsAug 20th, Subassets & Unique assets 2018 ==
Asset testnet liveRavencoin forked to include the Dark Gravity Wave difficulty adjustment to protect itself against hash rate attacks. Check [[testnet]] for more details, The problem and solution to the problem was explained [[Testnethttps://medium.com/@tronblack/ravencoin-dark-gravity-wave-technical1da0a71657f7 here]] for details about the anatomy of a Ravencoin asset transaction script.
==Phase 2&4 - Assets, Subassets & Unique assets - Nov 5th, 2018 ==Asset FAQ written by Tron on Medium [https://medium.com/@tronblack/ravencoin-asset-faq-e0d04d460e9b (20 Aug 2018) In addition to asset functionality being FAQ] written by Tron on available to test on testnet - Ravencoin is forking to include Dark Gravity Wave to protect itself against hash rate attacks - exchanges and mining pools need to upgrade as soon as possible to the latest wallet release, users as soon as they want to use their coins. [[Forks_and_updates]]Medium
===Asset info for Main Net===
===Global burn address===
If you want to get rid of for example Assets assets you do not want. You can send them to a global burn address:
https://ravencoin.network/address/RXBurnXXXXXXXXXXXXXXXXXXXXXXWUo9FV
== New Mining Algorithm X16Rv2 - Oct 1st, 2019 ==[https://medium.com/@tronblack/ravencoin-asic-thoughts-e6c0079609e6 As it became evident that X16R ASICs were developed and mining Ravenvoin in July 2019], the X16R mining algorithm was adapted with a small modification to X16Rv2. This adaptation involved adding an extra hashing algorithm to three of the 16 existing ones, which greatly reduces the times an ASIC can be used (~3.5%). X16Rv2 was implemented using an [https://github.com/bitcoin/bips/blob/master/bip-0099.mediawiki#asic-reset-hardfork ASIC-reset-hardfork]. Development progress and code is available here: https://github.com/RavenCommunity ==Phase 3 - Dividends/Rewards- Feb 7th, 2020==Rewards, also sometimes called dividends, provides a way to send tokenized assets or RVN to token holders by percentage of tokens held. Dividend support can be done without modifying the protocol. Rewards do not require a consensus protocol change, and the rpc calls exist to be able do rewards already. These capabilities just make it native and easy-to-use from the client. ===Resources===* [https://github.com/RavenProject/Ravencoin/tree/master/roadmap/rewards The Roadmap for Rewards is here on Github] ===Use examples===* Reward shareholders with profits (denominated in RVN)* Reward membership holders* Reward those that contributed the most to a shared project and earned special tokens ==Phase 5 - Messaging, OIP, and Restricted Assets - Feb 7th, 2020==A message is "broadcast" if an owner token or channel token is sent in a transaction to the same address with the addition of an IPFS hash and an optional expiration date. The message isn't really broadcast in the sense of being transmitted to nodes, but rather each node will independently detect the special transaction type and display the message. Message display is subject to some heuristic anti-spam rules.  === IPFS Integration ===IPFS (Interplanetary File System) is used by Ravencoin for issuance meta-data, messaging, and transaction meta-data. Ravencoin must interact with IPFS in order to show messages because the message content is stored on IPFS. IPFS access should be on by default, but should be able to be turned off with a flag. A two phase approach will allow Ravencoin to use IPFS natively, but it will also use existing IPFS proxies. === OIP Integration ==='''(NEW)''' Open Index Protocol allows for richer meta data and will get support in Ravencoin in addition to IPFS. You can find more on what you can do with OIP [https://oip.wiki/Main_Page here]. You will have to choose between adding OIP or IPFS meta data. Fortunately, OIP metadata also allows for adding IPFS.
Pay your token holders in RVN=== Restricted Assets ==='''(NEW)''' Restricted assets will be a new kind of assets that come with tags. Turn your profits into RVN and The issuer can send out tags to Ravencoin addresses that tell the entire chain that the asset can go there. The purpose of these restrictions is to all holders limit the transferability of your a token by percentage heldto known good actors, but without revealing the identity of the actors to anyone other than the original entity that verifies their identity. Only when legally required to do so, would the verifier reveal the identity.
Dividend support It introduces 2 token types:* One starts with a $ and represents a completely new token type which is a Restricted Asset. Restricted Assets only move to Tagged addresses.* The other starts with a # and is a Tag. Tags tokens can only be done without modifying transferred by the protocolissuer. We can add it to a version of the software that Tag tokens can be used sent or revoked only by the payer, without requiring others to upgrade (i.e., a soft fork)Tag issuer.
If you require this functionality ask in #dev channel on discord Restricted assets offer a solution to SEC compliance for security tokens: Ravencoin will allow for appending externally-validated trust from interested parties such as regulators, through intermediate Qualifiers such as there is a python script KYC/AML provider consortia, down to get owners individual addresses. Issuers of assetscan leverage the tags to manage how their assets can move about the chain. In this way, affirmation of an address’ status (such as KYC/AML compliant, accredited investor, or current subscriber) is possible without exposing or replicating the addressee’s Personally Identifiable Information (PII), and where the burden of establishing and maintaining trust in these qualifying tags is borne primarily by the regulated entities and someone could write code to loop through owners paying to their addressregulators that require such information in the first place.
==Phase 5 =Resources===* [https://medium.com/@tronblack/ravencoin- kaaawww-2f72077aece Messaging==is decribed in the KAAAWWW! protocol]. * [https://github.com/RavenProject/Ravencoin/tree/master/roadmap/messaging The Roadmap for messaging is here on Github]* [https://github.com/RavenProject/Ravencoin/tree/master/roadmap/messaging-antispam The Roadmap for spam prevention is here on Github]* [https://github.com/RavenProject/Ravencoin/tree/master/roadmap/ipfs The Roadmap for IPFS integration is here on Github]* [https://medium.com/@tronblack/ravencoin-tags-and-restricted-assets-84fe3070a226 Ravencoin — Tags and Restricted Assets]* [https://medium.com/@tronblack/ravencoin-restricted-asset-sec-compliance-how-to-1-fe507a6a4ae9 Ravencoin — Restricted Asset SEC Compliance How To]* [https://oip.wiki/Main_Page OIP Wiki]
Broadcast a message to all of your token holders.===Use examples===
* Send information about your token.
* Send alerts relevant to your project.
* Use Raven messaging for other systems.
==Phase 6 - VotingNew Mining Algorithm KAWPOW (May 6th 2020) ==To battle ASICs in the long term, Ravencoin developers are developing a new hashing algorithm: KAWPOW, which is a variant of ProgPOW with parameters specifically for Ravencoin. The change will be implemented using an [https://en.bitcoin.it/wiki/BIP_0099#ASIC-reset_hardfork ASIC reset hardfork ]. For more info on how to mine, see https://minermore.com/docs/help/ravencoin_fork/ An open source kawpowminer by Ravencoin community devs is here: https://github.com/RavenCommunity/kawpowminer/releases
More info on mining here: https://medium.com/@jeroz9009/ravencoin-tutorial-kawpow-mining-748158f63e11
 
== BIP44 Seed Words in Raven Core Wallets (May 6th 2020) ==
Ravencoin core is going to default to using BIP44 starting with version 4. The iOS and Android RVN Wallet is already BIP44, and Mango Farms web wallet is also BIP44.
If you’ve already created a wallet before the version 4 release, then it will continue to use just the BIP32 HD derivation and should be backwards compatible with your existing wallet.dat file. If Ravencoin core does not find a wallet.dat, it will prompt you and give you 12-words to write down as your backup. You should still encrypt your wallet and never forget your password.
 
See: https://blog.ravencoin.email/post/ravencoin-bip44
 
==Phase 6 - Voting (Aim: Q4 2020 or later)==
Ravencoin will support voting. Creating a vote will create vote tokens. These vote tokens are identical to normally issued tokens, except that they are created in exact qty and units as an already issued token. Vote tokens move just like regular tokens up until the block height when the vote expires. This allows vote token holders to send their vote to a delegate that might have better information about the topic and therefore cast a more informed vote. The feature will also allow voting by percentage of ownership. Second tier web voting can be built on top of this protocol.
 
===Resources===
[https://github.com/RavenProject/Ravencoin/tree/master/roadmap/voting The Roadmap for Voting is here on Github]
 
===Example===
Issue a special vote token to every holder of your token.
* Send to <address X> to vote for X proposal
* Send to <address Y> to vote for Y proposal
Second tier web voting can be built on top of this protocol.
==Phase 7 - Compatible Mode(Kawwwmeleon)==Allows newly created assets '''04/01/2019 Dev Meeting update''' The idea is to allow ravend to appear exactly act as a daemon that looks like RVNa single coin/token/asset. To realize this, LTCthe ravend daemon should be reconfigurable to listen to a transfer RPC call such as senttoaddress or sendfrom, or Bitcoin but in this case it would be for a specific asset and not Ravencoin. This would allow easy asset integration into exchangesexisting systems.  ===Example===The config for the asset FREE_HUGS might look like: {"port":2222, wallets"asset":"FREE_HUGS", explorers"rpcuser":"hugger", etc."rpcpass":"gi3afja33"} This speeds adoption into So, sendtoaddress on the larger crypto ecosystemnew port (non-RVN port) would send FREE_HUGS.
=Using the Ravencoin platform=
==Dev Kit=='' Current commands are as of Oct 13thThe Ravencoin Dev Kit is available and maintained at https://github.com/RavenDevKit. The dev kit contains e.g., * A JavaScript Ravencoin library, * An Extensible full node,* A full stack for Ravencoin blockchain-based applications, * A Ravencoin blockchain explorer UI,* A Ravencoin blockchain API for web wallets,* Ravencoin Message Verification and Signing for Ravencore,* Interface to the bitcoin P2P network for Ravencore,* Tools for running a local Ravencore development node, 2018* Website for https://ravencoin. Be sure com,* A client library to connect to check the QT wallet on github Ravencoin RPC in JavaScript,* Debian packaging for up Ravencore, * A helper to add tasks to date commands ''gulp,* x16r library for Ravencore,* Treat a collection of Buffers as a single contiguous partially mutable Buffer.
==Asset control==
'' Current commands are as of v2.2.0. Be sure to check the QT wallet on github for up to date commands ''
issue (asset_name, qty, to_address, change_address, units, reissuable, has_ipfs, ipfs_hash)
Issue an asset with unique name. Unit as 1 for whole units, or 0.00000001 for satoshi-like units. Qty should be whole number. Reissuable is true/false for whether additional units can be issued by the original issuer.
getassetdata (asset_name)
Lists asset data of an asset.
 
== Detailed Asset Support ==
===General===
The Ravencoin network consists of nodes communicating on port 8767.
 
The asset information is available by request on the network. Specify a list of asset names to request information about each asset. Requests for information on up to 512 assets can be made per request. Return messages will be sent separately. Asset not found information may be grouped together for optimization.
 
Information about each asset is important for:
* Asset creation because assets must be unique
* Asset display because the asset information contains the number of decimal places to display.
* Asset meta-data display - Requires the IPFS hash to show additional information about the asset.
* Asset re-issue status to prevent reissuance attempts on a locked asset.
* Asset qty issued to prevent reissuance attempts on a fully issued (21 billion) asset.
 
There are three networks:<br />
Mainnet which uses a network identifier '''RAVN'''<br />
Testnet which uses a network identifier '''RVNT'''<br />
RegTest which uses a network identifier '''CROW'''<br />
 
An additional command has been added to the network for asset support. This can be used by SPV nodes to get information about assets without interacting with a centralized API or a Remote Procedure Call.
 
===Network call getassetdata()===
The following is the specification for this new network call - available starting with network version 70018
 
Example 1: Request for asset name that doesn't exist
Request -> getassetdata
HEADER: 43524f5767657461737365746461746110000000571db430
DATA: 010e4241445f41535345545f4e414d45
Data Breakdown:
01 - Varint size of the vector
0e - Size of element = e.g. 14 Bytes
4241445f41535345545f4e414d45 - Name of asset = e.g. "BAD_ASSET_NAME"
--------------------------------------------------------------------
Response -> asstnotfound
HEADER: 43524f57617373746e6f74666f756e6410000000571db430
DATA: 010e4241445f41535345545f4e414d45
Data Breakdown:
01 - Varint size of the vector
Oe - Size of element = e.g. 14 Bytes
4241445f41535345545f4e414d45 - Name of asset = e.g. "BAD_ASSET_NAME"
 
Example 2: Request for asset name that does exist, and an asset that doesn't exist
Request -> getassetdata
HEADER: 43524f576765746173736574646174611d0000004a54c291
DATA: 020c41535345545f4a4552454d590e4241445f41535345545f4e414d45
Data Breakdown:
02 - Varint size of the vector
0c - Size of element = e.g. 12 Bytes
41535345545f4a4552454d59 - Name of asset = e.g. "ASSET_JEREMY"
0e - Size of element = e.g. 14 Bytes
4241445f41535345545f4e414d45 - Name of asset = e.g. "BAD_ASSET_NAME"
--------------------------------------------------------------------
First Response -> assetdata
HEADER: 43524f576173736574646174610000001d000000200a58aa
DATA: 0c41535345545f4a4552454d5900e1f50500000000 00010000f5010000
Data Breakdown:
0c - Size of name = e.g. 12 Bytes
41535345545f4a4552454d59 - Name of asset = e.g. "ASSET_JEREMY"
00e1f50500000000 - Amount = e.g. 100000000
00 - Units = e.g. 0
01 - Reissuable = e.g. 1
00 - hasIPFS = e.g. 0
00 - Size of IPFS hash
f5010000 - Block height
Second Response -> asstnotfound
HEADER: 43524f57617373746e6f74666f756e6410000000571db430
DATA: 010e4241445f41535345545f4e414d45
Data Breakdown:
01 - Varint size of the vector
Oe - Size of element = e.g. 14 Bytes
4241445f41535345545f4e414d45 - Name of asset = e.g. "BAD_ASSET_NAME"
 
Examples 3: Request for asset name that contains an IPFS HASH
Request -> getassetdata
HEADER: 43524f5767657461737365746461746118000000e6218523
DATA: 011641535345545f4a4552454d595f574954485f49504653
Data Breakdown:
01 - Varint size of the vector
16 - Size of element = e.g. 22 Bytes
41535345545f4a4552454d595f574954485f49504653 - Name of asset = e.g. "ASSET_JEREMY_WITH_IPFS"
--------------------------------------------------------------------
Response -> assetdata
HEADER: 43524f5761737365746461746100000049000000cb345766
DATA: 1641535345545f4a4552454d595f574954485f4950465300e1f50500000000000101221220da203afd5eda1f45deeafb70ae9d5c15907cd32ec2cd747c641fc1e9ab55b8e8f6010000
Data Breakdown:
16 - Size of name = e.g. 22 Bytes
41535345545f4a4552454d595f574954485f49504653 - Name of asset = e.g. "ASSET_JEREMY_WITH_IPFS"
00e1f50500000000 - Amount = e.g. 100000000
00 - Units = e.g. 0
01 - Reissuable = e.g. 1
01 - hasIPFS = e.g. 0
22 - Size of IPFS hash - 34 Bytes
1220da203afd5eda1f45deeafb70ae9d5c15907cd32ec2cd747c641fc1e9ab55b8e8 - IPFS hash data
f6010000 - Block height
==IPFS - InterPlanetary File System==
You can add a document to an asset as metadata for any purpose. Such , such as instructions, a low-res image of a piece of art that is represented by the token, your website, etc. Messaging will also support IPFS.
Currently, there is not (yet) IPFS support directly in the Raven wallet. However, you can upload content to e.g., https://globalupload.io/ and add the hash of the content to the asset that you are creating.
==Other documentation==
 
Atomic swaps: https://github.com/RavenProject/Ravencoin/blob/master/doc/atomicswaps.md
Issue assets in bulk: https://github.com/RavenProject/Ravencoin/tree/master/assets/tools
 
= Testnet =
This testnet network will be a completely independent secondary blockchain for testing purposes only, in which all tokens will have no intrinsic value and will not be traded on exchanges. The purpose of a testnet is to test features and functionality before introducing those features and functionality to the main blockchain. It is a playground to experiment and test different features with almost no cost to transact or mine blocks. During this testing phase, the Ravencoin blockchain itself will continue to maintain the same operation and functionality it has today.
 
To run your current wallet in testnet mode (Windows):
# First shutdown your current full client wallet.
# Create a shortcut to your raven-qt.exe
# Right click the shortcut, choose details and add '-testnet' to the target field. Example: <br /> <pre>"C:\Users\<username>\Path\to\executable\raven-qt.exe" –testnet</pre>
# Open the wallet by clicking on the shortcut you just made, and let the blockchain sync fully
 
{| class="wikitable"
! Read this section carefully: BE SAFE AND DON'T CONFUSE YOUR MAINNET WALLET WITH THE TESTNET WALLET!
|-
| Don't worry, this will not interfere with your regular Raven wallet, just make sure both wallets are not running at the same time. For those who are technically inclined, running in testnet mode does not overwrite any of the blockchain data or wallet files of Ravencoin’s main network. Instead, it will create a subfolder named testnet3 inside your data folder where all testnet related data and wallets reside.
 
'''If you would prefer to err on the side of caution, consider running your testnet wallet on a different computer.'''
|}
 
If you have additional questions about testnet, please see [https://www.reddit.com/r/Ravencoin/comments/94ju8y/come_join_us_on_testnet_and_try_out_rvn_assets/ this subreddit thread] or the [https://discord.gg/9mxhNjS #testnet channel in Discord.]
 
There are currently a couple of tools available to assist you with testnet testing.
 
*A fully functional block explorer for testnet Ravencoin is available at https://testnet.ravencoin.network/.
*A faucet which will issue you 5000 free '''testnet Ravencoin''' per click, is also at https://testnet.ravencoin.network/ or http://ravencoin.asset-explorer.net/faucet
*A testnet version of the Pocket Raven Web Wallet is at https://testnet.pocketraven.com/
*You can GPU mine for testnet RVN on MinerMore's testnet pool at https://minermore.com/pool/RVNt/
 
'''Testnet Technical Information:''' [[Testnet-technical| Technical Information]]
 
= Bug bounty =
There is a 100k RVN [https://github.com/RavenProject/Ravencoin/wiki bug bounty] available if you can find bugs that fork the chain.
 
And here is [http://htmlpreview.github.io/?https://github.com/hans-schmidt/mastering_ravencoin/blob/master/analysis/What_is_wrong_with_Ravencoin_testnet6_block_38554.html an example] of a bug found that got paid a bounty - happy bug hunting!
= Community Projects =

Navigation menu