counterpartyxcp/documentation

Official Documentation of the Counterparty Project

documentation's Issues

How to install / run with existing bitcoind full node already in place

There is no explanation on how to run against an existing bitcoin install. I tried to find in the configuration a place where I can avoid launching another bitcoind but I could not find it.

Any clue would be most welcome.

Thanks

Some issues I ran into on install

Here's a few issues I ran into and what I had to do to resolve them:

---

The docs say:

mkdir ~/.local/share/counterparty-docker-data

This is only accurate if you're not overriding COUNTERPARTY_DOCKER_DATA.

In that case you have to do:

mkdir $COUNTERPARTY_DOCKER_DATA/counterparty-docker-data

I know that doesn't follow the same parent path, but for me, it was complaining that

/home/vectorconfetti/storage/counterparty-docker-data

didn't exist when I set $COUNTERPARTY_DOCKER_DATA to /home/vectorconfetti/storage

---

There's also a typo:

COUNTERPARTY_DOCKER_DATA=/var/data docker compose up -d

should be

COUNTERPARTY_DOCKER_DATA=/var/data docker compose  --profile mainnet  up -d

---

I was also getting permissions errors running as an unprivileged user trying to connect to

unix:///var/run/docker.sock:

and this worked:

sudo setfacl --modify user:$USER:rw /var/run/docker.sock

---

I also had docker installed as root so I had to do this:

sudo chown -R vectorconfetti:vectorconfetti /var/lib/docker/volumes/

or maybe it would have been enough to do just this, not sure:

sudo chown -R vectorconfetti:vectorconfetti /var/lib/docker/volumes/counterparty-core_data

Subassets link is broken

The link at https://counterparty.io/docs/api/#subassets that is pointing to protocol_specification.md is broken.

The docs point to https://counterparty.io/Developers/protocol_specification.md#assets but that's 404

Wrong counterblock port in docs?

"By default, counterblock will listen on port 4001 for API requests. " => this comes from https://github.com/CounterpartyXCP/Documentation/blob/master/Developers/counterblock_API.md

It should be 4100 and not 4001 I think.

Write a 'Getting Started' or Installation doc

Discuss btcd as an Alternative to Patched Bitcoin Core?

Invalid link on http://counterparty.io/docs/windows/

The link for the "Microsoft Visual C++ 2008 Redistributable Package (x86)" is invalid

Update Exchange Integration to include MPMA

The exchange integration docs should be updated to include MPMA , as that will reduce the operational cost on exchanges and allow for batching sends in a single transaction.

https://counterparty.io/docs/exchange_integration/

Additional linking

http://counterparty.io/platform/
http://counterparty.io/why-counterparty/
http://counterparty.io/get-started/

Mentions of Counterwallet, Support, Coinmarketcap, etc. should probably link to their corresponding destination. (Obviously not all mentions, but it wouldn't hurt to have more clickthrough opportunities.)

Add enhanced send to UI/CLI

See CounterpartyXCP/counterparty-cli#114

parser_send.add_argument('--memo', help='A transaction memo attached to this send')
parser_send.add_argument('--memo-is-hex', action='store_true', default=False, help='Whether to interpret memo as a hexadecimal value')
parser_send.add_argument('--no-use-enhanced-send', action='store_false', dest="use_enhanced_send", default=True, help='If set to false, compose a non-enhanced send with a bitcoin dust output')
 
'send': ['source', 'destination', 'asset', 'quantity', 'memo', 'memo_is_hex', 'use_enhanced_send'],

Mention `pubkey` parameter in API.md

The pubkey parameter is not mentioned in various API commands.

Add numeric assets to homepage

Currently mentions only 0.5 XCP named assets:

http://counterparty.io/get-started/
http://counterparty.io/why-counterparty/

In the section "create a custom token" (get started), the tutorial doesn't mention numeric assets, and states that asset names can be up to 14 characters long. (It's now 12, I believe.)

Also my proposed wording would be that assets are always free, but having a name is what costs 0.5 XCP.

Document `--force` CLI Argument

Counterpartyd RPC credentials don't match documentation

https://counterparty.io/docs/api/ shows the credentials as rpc:1234, in reality the docker container has the defaults rpc:rpc.

Publish Recent Commits Adam Made

and update README to include instructions for updating and publishing

windows.md: semi-official site with OpenSSL for Win binaries is dead

It's been dead for 7 days.
There's a second semi-official site, http://indy.fulgan.com/SSL/, but the files are zipped and need to be uncompressed and installed manually (may require documentation updates).

List of "semi-official" sites with binary builds can be found at https://www.openssl.org/about/binaries.html

There's an unofficial location with binaries, but I can't tell whether they were copied from SLProWeb.com or built by these guys since slproweb.com is down.
http://code.x2go.org/releases/binary-win32/3rd-party/Win32OpenSSL/?C=M;O=D

Typo in EVM Faq

"coutnerparty"

Missing reference link in CP API doc

"For examples of filtering in-use, please see the examples." => link to Examples doesn't work, but I'm not sure if it's supposed to work.
Where: http://counterparty.io/docs/api/

DB connection pooling for API

Stop Recommending `pip` and `setup.py` Installation with `sudo`?

update API docs for `dust_return_pubkey` advanced param

dust_return_pubkey option now works with both multisig and p2sh encoding formats... need to update docs to match code.

Hacker News Thread on API Specs.

https://news.ycombinator.com/item?id=8912897

Add Smart Contract description to Counterparty_features.md

Document Purpose and Properties of `messages` Table

The key is that Counterparty is a deterministic state machine.

Uses

• detect discrepancies between state of multiple nodes and across versions (balance this with hiding implementation details and having stable hashes across upgrades)
• use for building e.g. a secondary block explorer DB (note! no guarantee of backwards-compatibility!)
• manage the mempool (?)
• integrate with logging of deterministic events

Remove or update getinfo in docs

• ... once CounterpartyXCP/counterparty-cli#105 is closed
• https://github.com/CounterpartyXCP/Documentation/blob/master/UI/CLI.md#getinfo

Homepage alignment issue

The numbers in the buttons on "get started" are not centered.

Add destroy command to UI/CLI and API

First confirm it's implemented

Asset description length not arbitrary?

I would consider this very low priority...

Protocol Specification states, "Asset descriptions may be of arbitrary length." However, it appears, at least when using Counterwallet, that 40 bytes is the limit for a description.

I have seen discussion online about 80 bytes being possible, depending on OP_RETURN settings.

This page states: https://counterparty.io/docs/api/ 52 bytes is the max.

There are also asset descriptions in the wild like: https://res.indiesquare.me/json/A2106870093763980398.json which are 57 bytes.

Perhaps, this part of the documentation can be clarified by someone who knows more than I do.

This is specifically about the description in an issuance, and not an enhanced asset info description which is 2048 chars max.

HTTP REST API

• Link to Apiary
• Warn that API isn't finalized.

Exchange integration needs to be updated

https://github.com/CounterpartyXCP/Documentation/blob/master/Developers/Notes_and_Tutorials/exchange_integration.md

API Docs are Behind

• document new API calls like get_assets
• as well as the new objects types that can be returned (like assets object)
• mention pubkey parameter
• get_tx_info
• unpack

Moved from CounterpartyXCP/counterparty-core#716

Add `get_tx_info` and `unpack` to API docs