Skip to content

thebitcoinhole/seed-backup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

The Bitcoin Hole - Seed Backup

Introduction

Comparing seed phrase metal backup solutions feature by feature

Collaboration

Inside the items directory, there is a JSON file for each seed backup gadget, with all the data about it. To collaborate (adding missing data, fixing wrong data or adding a new item), just fork the repository and send a pull request with the changes.

Before sending the pull request, please run the following commands to format the JSON:

cd scripts/
node json-format.js

JSON format

The following is a sample of the JSON format:

{
    "id": "item-id",
    "name": "Item Name",
    "purchasable": true,
    "category-name": {
      "feature-name-1": {
        "value": "YES", 
        "flag": "positive",
        "supported": true,
        "texts": [
          "Optional contextual text describing the feature"
        ],
        "links": [
          {
            "title": "Optional contextual link referencing official documentation",
            "url": "url"
          }
        ]
      },
      "feature-name-2": {
        "value": "Experimental",
        "flag": "neutral",
        "supported": true
      },
      "feature-name-3": {
        "value": "NO",
        "flag": "negative",
        "supported": false
      }
    }
}

JSON fields:

Field Type Required Description
id string true The item id. It matches with the JSON file name.
name string true The item name.
category-name.feature-name-1.value string yes The visible feature value. For example: "YES", "NO", "Experimental", etc
category-name.feature-name-1.flag string no The flag of the item feature. Possible values: "positive", "neutral" or "negative"
category-name.feature-name-1.supported boolean no If the feature is supported by the item. This is used to filter by this feature
category-name.feature-name-1.texts array of strings no Official Texts with info about the feature
category-name.feature-name-1.links array of objects no Official links with info about the feature
category-name.feature-name-1.links.title string yes The title of the link
category-name.feature-name-1.links.url string yes The url of the link

On each pull request, the JSON files are verified to be sure they are valid and well-formatted. You can run the following command inside the scripts directory to format the JSON before sending a pull request:

node json-format.js

All the features supported:

Category Category Id Feature Feature Id
Basic Information basic-information Price price
Basic Information basic-information Discounts discounts
Basic Information basic-information Amazon Official Store amazon
Company company Brand brand
Company company Headquarters headquarters
Company company Website website
Company company Blog blog
Company company X (Twitter) twitter
Company company Nostr nostr
Company company YouTube youtube
Payment Methods to buy the device payment-methods BTC On Chain btc-on-chain
Payment Methods to buy the device payment-methods BTC Lightning btc-lightning
Payment Methods to buy the device payment-methods Alt Coins alt-coins
Payment Methods to buy the device payment-methods Credit/Debit Card credit-debit-card
Size & Materials size-materials Weight weight
Size & Materials size-materials Dimensions dimensions
Size & Materials size-materials Materials materials
Size & Materials size-materials Water-proof water-proof
Size & Materials size-materials Fire-proof fire-proof
Size & Materials size-materials Stress tests stress-tests
Backup Compatibility backup-compatibility Output Descriptor output-descriptor
Backup Compatibility backup-compatibility 12 Words BIP39 bip39-12-words
Backup Compatibility backup-compatibility 24 Words BIP39 bip39-24-words
Backup Compatibility backup-compatibility Shamir Backup SLIP39 shamir-backup
Backup Compatibility backup-compatibility Hexadecimal Strings hexadecimal-strings
Backup Compatibility backup-compatibility ASCII Strings ascii-strings

Website

The thebitcoinhole.com website offers a Seed Backup Gadgets Comparison using this database.

Sponsor this project

Sponsor this project to help us get the funding we need to continue working on it.

Follow us