adrian-d-hidalgo / azle-api-rest-ckbtc

Azle REST API with ckBTC Integration

This boilerplate is designed to easily build ExpressJS applications usin ckBTC (a Bitcoin pair) on ICP.

Features

• Build REST API on chain
• Work with SQL databases
• Persist database on chain
• Make ckBTC transactions

Run Locally

Clone the project

  git clone https://github.com/adrian-d-hidalgo/azle-api-rest-ckbtc

Go to the project directory

  cd azle-api-rest-ckbtc

Install dependencies

  npm install

# only for mac
codesign -s - .bitcoin/bin/bitcoind

npm run btc:start

In another terminal run:

npm run icp:start

Open another terminal and run:

npm run icp:deploy:local

How to mint ckBTC

Run the following command:

# only for mac
codesign -s - .bitcoin/bin/bitcoin-cli

npm run btc:mint --address=$ADDRESS

After minting, call the endpoint PUT /users/:userId/balance to update the account balance.

Then, you can verify the account balance in this endpoint: GET /users/:userId/balance

azle-api-rest-ckbtc's Issues

Best Practices for Generating Principals in Express-Azle

I am currently working on an Express.js application that integrates with Internet Computer Protocol (ICP) using the Azle framework. In the process of building my application, I've come across the need to generate new Principals for users.

But I still confuse and see your repository azle-api-rest-ckbtc noticed that the generateId() function in your codebase generates random bytes to create a new Principal. However, I am concerned that this method may not align with the best practices recommended by DFINITY, especially in terms of security and validity.

Could you please provide guidance or point me to the relevant documentation on the best practices for generating Principals within an Express.js application using Azle? I want to ensure that the Principals generated are both secure and compatible with the ICP network.