Skip to content

backeum/backeum-blueprint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Backeum blueprint

Test Security audit Compile Static Badge

Overview

Backeum Blueprint is the backbone of Backeum, a platform connecting creators and backers through cryptocurrency donations. The blueprint encapsulates the logic of smart contracts, meticulously crafted in Scrypto, and is deployed to the Radix Distributed Ledger Technology (DLT).

Components

1. Repository Component

The repository component is a factory component that delegates permissions to mint on the NFT resource. It is also responsible for merging different NFTs. The repository component is instantiated and managed by the Backeum team.

Responsible for:

  • Owning the NFT minting process.
  • Merging NFTs from the same collection.
  • Merging memberships from the same creator.
  • Serving as a factory that delegates permissions to mint on the NFT resource to the collection components.

2. Collection Component

Creators on Backeum use the collection component. Its primary functions include:

  • Receiving donations on behalf of the creators.
  • Issuing a trophy NFT as a token of appreciation and proof of backing a creator.
  • Issuing a membership NFT as a token of appreciation and proof of backing a creator.

Integration with Backeum Platform

This blueprint powers the smart contract interactions on the Backeum platform, a hub where creators and backers come together. Creators benefit from the support of the community, while backers receive unique trophy NFTs, cementing their role in the creator's journey.

Verify the integrity of the blueprint

The blueprint is compiled and deployed to the Radix DLT according to RDX Works recommendation of compiling the code deterministically. Be sure to install Docker before proceeding.

Pull the official scrypto-builder image from Docker Hub.

DOCKER_DEFAULT_PLATFORM=linux/amd64 docker pull radixdlt/scrypto-builder:v1.0.1

Clone the repository

git clone git@github.com:backeum/backeum-blueprint.git

Navigate into the git repository and then, run

DOCKER_DEFAULT_PLATFORM=linux/amd64 docker run -v $(pwd):/src radixdlt/scrypto-builder:v1.0.1

This will compile the code and generate a build directory. The build directory contains the compiled code.

Contribute

Contributions are always welcome! Whether it's enhancing the documentation, proposing new features, or fixing bugs, we value your insights and contributions.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Support and Community

For support or to join the Backeum community:


Made with 💙 by the Backeum team.