Skip to content

Latest commit

 

History

History
132 lines (113 loc) · 8.86 KB

ISSUE.md

File metadata and controls

132 lines (113 loc) · 8.86 KB
Raw

ISSUE command

This command creates or issues a BTNS token

PARAMS

Name Type Description
VERSION String Broadcast Format Version
TICK String 1 to 250 characters in length
MAX_SUPPLY String Maximum token supply
MAX_MINT String Maximum amount of supply a MINT transaction can issue
DECIMALS String Number of decimal places token should have (max: 18, default: 0)
DESCRIPTION String Description of token (250 chars max)
MINT_SUPPLY String Amount of token supply to mint in immediately (default:0)
TRANSFER String Address to transfer ownership of the token to (owner can perform future actions on token)
TRANSFER_SUPPLY String Address to transfer MINT_SUPPLY to (mint initial supply and transfer to address)
LOCK_MAX_SUPPLY String Lock MAX_SUPPLY permanently (cannot increase MAX_SUPPLY)
LOCK_MAX_MINT String Lock MAX_MINT permanently (cannot edit MAX_MINT)
LOCK_MINT String Lock token against MINT command
LOCK_MINT_SUPPLY String Lock token against issuing additional supply via MINT_SUPPLY
LOCK_DESCRIPTION String Lock token against DESCRIPTION changes
LOCK_RUG String Lock token against RUG command
LOCK_SLEEP String Lock token against SLEEP command
LOCK_CALLBACK String Lock token against CALLBACK command
CALLBACK_BLOCK String Enable CALLBACK command after CALLBACK_BLOCK
CALLBACK_TICK String TICK token users get when CALLBACK command is used
CALLBACK_AMOUNT String TICK token amount that users get when CALLBACK command is used
ALLOW_LIST String TX_HASH of a BTNS LIST of addresses allowed to interact with this token
BLOCK_LIST String TX_HASH of a BTNS LIST of addresses NOT allowed to interact with this token
MINT_ADDRESS_MAX String Maximum amount of supply any address can mint via MINT transactions
MINT_START_BLOCK String BLOCK_INDEX when MINT transactions are allowed (begin mint)
MINT_STOP_BLOCK String BLOCK_INDEX when MINT transactions are NOT allowed (end mint)

Formats

Version 0

  • VERSION|TICK|MAX_SUPPLY|MAX_MINT|DECIMALS|DESCRIPTION|MINT_SUPPLY|TRANSFER|TRANSFER_SUPPLY|LOCK_MAX_SUPPLY|LOCK_MAX_MINT|LOCK_DESCRIPTION|LOCK_RUG|LOCK_SLEEP|LOCK_CALLBACK|CALLBACK_BLOCK|CALLBACK_TICK|CALLBACK_AMOUNT|ALLOW_LIST|BLOCK_LIST|MINT_ADDRESS_MAX|MINT_START_BLOCK|MINT_STOP_BLOCK|LOCK_MINT|LOCK_MINT_SUPPLY

Version 1 - Edit DESCRIPTION

  • VERSION|TICK|DESCRIPTION

Version 2 - Edit MINT PARAMS

  • VERSION|TICK|MAX_MINT|MINT_SUPPLY|TRANSFER_SUPPLY|MINT_ADDRESS_MAX|MINT_START_BLOCK|MINT_STOP_BLOCK

Version 3 - Edit LOCK PARAMS

  • VERSION|TICK|LOCK_MAX_SUPPLY|LOCK_MAX_MINT|LOCK_DESCRIPTION|LOCK_RUG|LOCK_SLEEP|LOCK_CALLBACK|LOCK_MINT|LOCK_MINT_SUPPLY

Version 4 - Edit CALLBACK PARAMS

  • VERSION|TICK|CALLBACK_BLOCK|CALLBACK_TICK|CALLBACK_AMOUNT

Version 5 - Edit LIST PARAMS

  • VERSION|TICK|ALLOW_LIST|BLOCK_LIST

Examples

bt:ISSUE|0|JDOG
This example issues a JDOG token 

bt:ISSUE|0|JDOG|1||||1|||1
This example issues a JDOG token with MAX_SUPPLY set to 1, Mints 1 token via MINT_SUPPLY, and has LOCK_MAX_SUPPLY set to 1 to permanently lock the MAX_SUPPLY

bt:ISSUE|0|JDOG|0|0|0|http://j-dog.net/images/JDOG_icon.png
This example issues a JDOG token with a DESCRIPTION which points to an icon

bt:ISSUE|0|JDOG|0|0|0|http://j-dog.net/images/JDOG_icon.png|0|1JDogZS6tQcSxwfxhv6XKKjcyicYA4Feev
This example issues a JDOG token with a DESCRIPTION which points to an icon, and transfers token ownership to 1JDogZS6tQcSxwfxhv6XKKjcyicYA4Feev

bt:ISSUE|0|JDOG|1000|1|0
This example issues a JDOG token with a max supply of 1000, and a maximum mint of 1 JDOG per mint

bt:ISSUE|0|JDOG|1000|1|0|BTNS Tokens Are Cool!
This example issues a JDOG token with a max supply of 1000, and a DESCRIPTION of 'BTNS Tokens are Cool!'

bt:ISSUE|0|BRRR|10000000000000000000|10000000000000|0|https://j-dog.net/json/JDOG.json|100
This example issues a BRRR token with a max supply of 1 Quandrillion supply and a maximum mint of 1 Trillion BRRR per mint, associates a JSON file with the token, and immediately mints 100 BRRR to the broadcasting address.

bt:ISSUE|0|TEST|100|1|0||1|1JDogZS6tQcSxwfxhv6XKKjcyicYA4Feev|1JDogZS6tQcSxwfxhv6XKKjcyicYA4Feev
This example issues a TEST token with a max supply of 100, and a maximum mint of 1 TEST per mint. This also mints 1 TEST token, and transfers ownership AND initial token supply to 1JDogZS6tQcSxwfxhv6XKKjcyicYA4Feev

Rules

  • TICK must be 1 to 250 characters in length
  • TICK characters allowed are :
    • Any word character (alphanumeric characters and underscores)
    • Special characters: ~!@#$%^&*()_+-={}[]\:<>.?/
    • Most printable emojis in U+1F300 to U+1F5FF
  • TICK characters NOT allowed are :
    • pipe | (used as field separator)
    • semicolon ; (used as command separator)
  • ISSUE will be considered invalid if counterparty ASSET of same name exists
  • ISSUE will be considered invalid if counterparty SUBASSET of same name exists, or is possible
  • ISSUE may be considered valid if issuing address is the owner of the counterparty ASSET or SUBASSET of the same name
  • First TICK ISSUE with valid status will be the owner of the token
  • Additional TICK ISSUE transactions after first valid TICK ISSUE, will be considered invalid and ignored, unless broadcast from token owners address
  • DECIMALS can not be changed after token supply is issued and/or minted
  • MAX_SUPPLY max value is 1,000,000,000,000,000,000,000 (1 Sextillion)
  • MAX_SUPPLY can not be set below existing supply
  • LOCK_MAX_SUPPLY can not be set to 1 and permanently locked until MIN_TOKEN_SUPPLY supply exists.

Notes

  • ISSUE TICK with MAX_SUPPLY and MINT_SUPPLY set to any non 0 value, to mint supply until MAX_SUPPLY is reached (owner can mint beyond MAX_MINT)
  • ISSUE TICK with MAX_SUPPLY and MAX_MINT set to any non 0 value, to enable user minting (fair minting)
  • ISSUE TICK with LOCK_MAX_SUPPLY set to 1 to permanently lock MAX_SUPPLY
  • ISSUE TICK with LOCK_MAX_MINT set to 1 to permanently lock MAX_MINT
  • ISSUE TICK with LOCK_MINT set to 1 to permanently prevent use of the MINT command
  • ISSUE TICK with LOCK_RUG set to 1 to permanently prevent use of the RUG command
  • ISSUE TICK with LOCK_SLEEP set to 1 to permanently prevent use of the SLEEP command
  • ISSUE TICK with LOCK_CALLBACK set to 1 to permanently prevent use of the CALLBACK command
  • DESCRIPTION can contain a URL to a an icon to use for this token (48x48 standard size)
  • DESCRIPTION can contain a URL to a JSON file with additional information
  • DESCRIPTION can NOT contain any pipe | or semi-colon ; characters, as these are reserved
  • CALLBACK_BLOCK, CALLBACK_TICK, and CALLBACK_AMOUNT can be edited via ISSUE action if token supply is NOT distributed
  • DEPLOY ACTION can be used for backwards-compatability with BRC20/SRC20 DEPLOY
  • By default any address can interact with a BTNS token, to change this behavior use ALLOW_LIST and BLOCK_LIST
  • If TICK contains any unicode characters, then TICK should be base64 encoded
  • counterparty ASSET and SUBASSET names are reserved within the BTNS for use by the counterparty owner
  • MINT_ADDRESS_MAX can be used to limit the maximum TICK AMOUNT that a single address can MINT
  • MINT_START_BLOCK and MINT_STOP_BLOCK can be used to determine period(s) when MINT transactions are allowed