Lisk Token Claim

This repository is a monorepo for essential non-contract services for the LSK Token Claim on the Lisk L2.

Table of Contents

• Packages
  • Tree Builder
  • Token Claim Backend
  • Token Claim CLI
• Setup and Installation
• Docker
• Contributing
• License

Packages

In this monorepo there are currently 2 packages:

Tree Builder

Builds a Merkle Tree from a snapshot and computes the Merkle Root.

Claim Backend

Perform as a backend server, compatible with JSON RPC 2.0 Standard.

The database is using PostgreSQL.

Claim CLI

A command-line tool to claim LSK token by submitting transaction directly on-chain.

Setup and Installation

The Node version for this project is 18. Make sure you have the correct version installed. If you are using nvm, run nvm use 18.

1. Clone Lisk Token Claim Repository

$ git clone [email protected]:LiskHQ/lisk-token-claim.git

2. Install Node dependencies and build project

$ yarn && yarn build

Docker

Dockerfiles are stored at the docker folder. To build the docker locally,

docker build -t lisk-claim-backend -f ./docker/claim-backend/Dockerfile .

Documentation

• Tech Design - A comprehensive document, including:

  • Project Background
  • Requirement of the project
  • Components of the project
  • Technical specification
  • Design

• Taking Snapshot - A detailed documentation for:

  • Obtaining Lisk v4 Snapshot
  • Data preparation for Merkle Tree Generation
  • Generate Merkle Tree for
    • Lisk Token Migration
    • Migration Airdrop

• Detailed Guide to Claim CLI Tool - A detailed documentation for:

  • Claiming Lisk tokens without the need for UI
  • Detailed steps of the claim process using CLI

Contributing

If you find any issues or have suggestions for improvements, please open an issue on the GitHub repository. You can also submit pull requests with bug fixes, new features, or documentation enhancements.

License

Copyright 2024 Onchain Foundation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.