shruggr / 1sat-run-import

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

runto1sat

CLI tool for migrating Run tokens to 1Sat Ordinals.

Features

  • Download Run token data for your RelayX seed phrase
  • View / search your tokens
  • Mint new 1Sat Ordinals (spends Run tokens)

Requirements

This tool requires redis is installed and available on port 6379 (default redis port). Redis is used to cache token data.

NOTE: The run-sdk is deprecated and requires node v16 or lower.

If you don't have nvm already, install it. Install v16, hen run nvm use in the project folder to use the version specified by .nvmrc.

Environment Variables

Rename the .env.example to .env and fill in your RelayX mnemonic and 1Sat Ordinals destination address where you would like to send tokens after migrating.

  • MNEMONIC - Your RelayX mnemonic
  • DESTINATION_ORD_ADDRESS - Your 1Sat Ordinals address

Install

  1. Clone this repo:
git clone https://github.com/shruggr/1sat-run-import.git
  1. Install dependencies:
npm i
  1. Install the runto1sat command globally (optional)
npm i -g .

If you don't want to install the runto1sat command globally, you can run the tool directly from the project folder:

npm run start -h

Usage

  1. Import your run token data
runto1sat import
  1. View imported token details
runto1sat view
  1. Migrate a token
runto1sat migrate <id>

Run the help menu for a list of commands:

runto1sat start -h

Importing RunLocked tokens

You can get all listings using the original "order lock" contract using JungleBus.

  1. Go to junglebus.gorillapool.io and sign up
  2. Create a new subscription. Put your identity address in the addresses field, and "runlock" in the "type field.
  3. Add your subscription ID to the .env file
  4. Run the following command to get all listings
runto1sat subscribe

Roadmap

  • Import token data from utxos
  • View imported token details
  • Import live orderlock (a.k.a. Run lock)
  • Cancel open Run lock orders
  • Mint new 1Sat Ordinals (spends Run tokens)

About


Languages

Language:JavaScript 100.0%