Add XAHICO project

[nescampos]

Project Overview 📖

• Project Name: XAHICO
• Folder Project Name Inside submissions Branch: xahico
• Project Description: Xahico is a small project that uses Xahau Smart Contracts to turn any XRPL wallet into an ICO manager, where every time it receives a payment in XRP/XAH, it automatically sends the originator of the transaction a certain amount of corresponding tokens, similar to an Initial Coin Offering in other Blockchain networks.

Project Details 🛠

• Included Project Files (code, documentation, etc.)
• Detailed README.md file containing:
  • Project Description
  • Instructions on How to Use the Project
  • Integration Details for Xahau Hooks - if used

How to Use the Project 🚀

1. Create a new token on XRPL that you want to sell.
2. Send a certain amount of those tokens to a wallet that will be the manager of the Initial Coin Offering, for example, if you want to sell 10% of the total, only send 10% then.

• As a good practice, keep the wallet that creates the token separate from any transaction or process like an ICO, but if you are going to keep the whole process in the same wallet, skip this step.

3. Copy the .env.example file and rename it to .env.
4. Update the parameters in the .env file:

• ICO_WALLET_SEED: The seed of the wallet that will be the manager of the ICO (step 2).
• ICO_CURRENCY_SYMBOL: The symbol of the token you have created.
• ICO_CURRENCY_ISSUER: The token issuer (wallet from step 1 or 2 depending on your setup).
• ICO_CURRENCY_RATIO: The ratio for the sale. This ratio depends on the decimals of the tokens. For example, if you want to sell 1 token at 0.5 XRP/XAH, that is your ratio.

5. Run this code to deploy the hook on the wallet:

yarn run deploy

6. Run a test from another wallet and send a certain amount of XRP and you should receive a certain amount of tokens.

• Remember that you must have a Trustline to successfully receive tokens from this account.

Integration with Xahau Hooks 🔗

The project creates a hook and associates it with a wallet, which will be in charge of the ICO sales process (ideally it should not be the same wallet that owns/creates the token, to follow good practices).

Mandatory Tweets 🐦

Submissions will be shared and amplified by the @XahauNetwork account, giving your work additional visibility within the community.

• First Mandatory Tweet announcing your participation: https://x.com/nes_campos/status/1884308494024921405

• Second Mandatory Tweet upon submission for final review: https://x.com/nes_campos/status/1884310302046707780

Additional Information 📄

There are additional topics that I will update in the coming days, or after the hackathon if I don't have time now.

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@transia/[email protected]	environment, filesystem Transitive: eval, network	+111	24.2 MB	transia
npm/@tsconfig/[email protected]	None	0	2.45 kB	typescript-deploys
npm/[email protected]	environment, filesystem	0	75.8 kB	motdotla
npm/[email protected]	None	+4	25.5 MB	transia
npm/[email protected]	environment, filesystem, unsafe	+17	4.42 MB	blakeembrey
npm/[email protected]	None	0	66.8 MB	typescript-bot

View full report↗︎