Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spacebudz/wormhole
https://github.com/spacebudz/wormhole
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/spacebudz/wormhole
- Owner: spacebudz
- License: mit
- Created: 2022-11-16T12:36:30.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-02T14:27:48.000Z (5 months ago)
- Last Synced: 2024-10-02T08:45:36.421Z (4 months ago)
- Language: TypeScript
- Size: 2.36 MB
- Stars: 12
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Wormhole
The SpaceBudz wormhole contract. Moving from CIP-0025 to CIP-0068.
## Official SpaceBudz Policy
Policy Id: **4523c5e21d409b81c95b45b0aea275b8ea1406e6cafea5583b9f8a5f**
## Requirements
- Deno >= 1.28.1
## Installation
### Deno
```js
import { Contract } from "https://deno.land/x/[email protected]/mod.ts";
```
### NPM
```
npm install @spacebudz/wormhole
```
## Get started
```ts
import { Lucid, Blockfrost } from "https://deno.land/x/[email protected]/mod.ts";
import { Contract } from "https://deno.land/x/[email protected]/mod.ts";
const lucid = await Lucid.new(new Blockfrost(...));
lucid.selectWalletFromSeed(
"",
);
const contract = new Contract(lucid);
// Logging the SpaceBudz policy id
console.log(contract.mintPolicyId);
// Migrate SpaceBud #10
console.log(await contract.migrate([10]));
```
## Compile contract
```
deno task build:contract
```
See [requirements](./src/ghc/README.md).
## Bundle for NPM
```
deno task build
```
Outputs a `dist` folder.
Lucid needs to be imported separately and is a peer dependency (version `@0.10.9`).
## Contract endpoints
```ts
migrate(ids: number[]): Promise
```
```ts
deployScripts(): Promise
```
```ts
burn(id: number): Promise
```
```ts
move(id: number): Promise
```
```ts
updateIp(url: string): Promise
```
```ts
updateRoyalty(royaltyRecipients: RoyaltyRecipient[]): Promise
```
```ts
getRoyalty(): Promise
```
```ts
getMetadata(id: number): Promise
```
```ts
hasMigrated(id: number): Promise
```
```ts
getDeployedScripts(): Promise<{ mint: UTxO }>
```
## How the wormhole works
In order to migrate a SpaceBud of the old collection, three outputs need to be created:
- Lock address holding the old SpaceBud
- Reference address holding the `reference NFT` with the metadata in the datum
- Wallet address receives the `user NFT` that represent the new SpaceBud
The `reference NFT` and `user NFT` are minted during the transaction and need to follow the CIP-0068 (222) sub standard.
To validate metadata and correctness of the minted SpaceBud a merkle tree is used that contains 10,000 entries. Each entry is a `sha2_256` hash of:
```
metadata hash + asset name of reference NFT + asset name of user NFT + asset name of single asset sent to Lock address
```
Only a small merkle tree proof needs to be brought on-chain to make sure a SpaceBud is minted correctly
## Exceptions for Twin SpaceBudz
To keep integrity for the twins `1903` and `6413` (with quantity 2) some extra steps are required.
Important is that there exists only ever one reference NFT. In order to achieve this the reference NFTs including their respective metadata are preminted and locked in the script UTxO.
Whenever you migrate a twin you mint a mock reference NFT (with label 1), that doesn't really have any functionality, but it allows to keep the existing contract logic as it is.
No unnecessary complexity and risk needs to be introduced into the contract.