Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AmpleMintbase: Milestone 1 submission #156

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions submissions/AmpleMintbase_milestone1_2024_09_27.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Ample x Mintbase Streaming Royalty Claiming, Gated Function and Legal Doc Generator Builds
## Milestone 1: Smart Contract Royalty Claim & Gated Streaming Access Modules

### Deliverables

| Number | Deliverable | Link |
| ------------- | ------------- | ------------- |
| - | Main repo | https://github.com/AmpleProtocol/launchpad |
| 0a. | License | https://github.com/AmpleProtocol/launchpad/tree/master/LICENSE |
| 0b. | Documentation | - [main](https://github.com/AmpleProtocol/launchpad/blob/master/README.md) <br> - [core](https://github.com/AmpleProtocol/launchpad/blob/master/core/README.md) <br> - [ui](https://github.com/AmpleProtocol/launchpad/blob/master/ui/README.md) <br> - [client](https://github.com/AmpleProtocol/launchpad/blob/master/client/README.md) <br> - [server](https://github.com/AmpleProtocol/launchpad/blob/master/server/README.md) <br> - [contracts](https://github.com/AmpleProtocol/launchpad/blob/master/contracts/README.md) |
| 0c. | Testing guide | https://github.com/AmpleProtocol/launchpad?tab=readme-ov-file#testing-guide |
| 0d. | Docker | https://hub.docker.com/r/menurivera/ample-launchpad-server |
| 0e. | Article + video | https://youtu.be/H4EEH8ep2VU |
| 1. | Mintbase module: Streaming Royalty Percentage Claims | https://github.com/AmpleProtocol/launchpad/blob/master/ui/src/components/Royalty.tsx |
| 2. | Mintbase module: Gated Streaming Access Module | - https://github.com/AmpleProtocol/launchpad/blob/master/ui/src/components/Launch.tsx <br> - https://github.com/AmpleProtocol/launchpad/blob/master/ui/src/components/Player.tsx <br> - https://github.com/AmpleProtocol/launchpad/blob/master/ui/src/hooks/useStreaming.ts |
| 3. | ~~NEAR chain integration~~ <br> NPM packages | (We agreed upon an npm packages based approach, here are the links to them) <br> - [core](https://www.npmjs.com/package/@ample-launchpad/core) <br> - [client](https://www.npmjs.com/package/@ample-launchpad/client) <br> - [ui](https://www.npmjs.com/package/@ample-launchpad/ui) |

### Formtatted code

#### TypeScript
1. `camelCase` for variables, functions and properties
2. `PascalCase` for Classes
3. `PascalCalse` with an `I` for interfaces (like `ISomeInterface`)
4. `CONSTANT_CASE` for constants
5. `camelCase` for files

#### Rust
1. `snake_case` for variables, functions and properties
2. `PascalCase` for structs and impls
3. `CONSTANT_CASE` for constants
4. `snake_case` for files