You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+47-54Lines changed: 47 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,5 @@
1
1
## What is Mobile Minting?
2
+
2
3
Mobile Minting unlocks mobile payments for onchain purchases and powers minting in the Rally app (formerly known as Floor!).
3
4
4
5
**📱 Users pay in-app with In-App Purchases**
@@ -14,7 +15,8 @@ _Example Mobile Minting user experience._
14
15
<br />
15
16
16
17
## What is this repository?
17
-
This repository is a **public, contributable collection of Ingestors** that teach Mobile Minting how to support mints from new platforms.
18
+
19
+
This repository is a **public, contributable collection of Ingestors** that teach Mobile Minting how to support mints from new platforms.
18
20
19
21
Historically, only Rally could choose what mints users could mint through Rally based on our roadmap, or partnerships, now anyone can build support for any minting platform / product and (provided it meets some safety & reliability checks) it can be included in Mobile Minting.
20
22
@@ -24,7 +26,8 @@ This library is included in Rally's platform and executed in a sandboxed environ
24
26
25
27
## Adding a new platform to Mobile Minting
26
28
27
-
Today, Mobile Minting supports the following creator platforms:
29
+
Today, Mobile Minting supports the following creator platforms:
30
+
28
31
<table>
29
32
<tr>
30
33
<td>
@@ -162,23 +165,6 @@ Today, Mobile Minting supports the following creator platforms:
162
165
❌
163
166
</td>
164
167
</tr>
165
-
<tr>
166
-
<td>
167
-
Prohibition Daily
168
-
</td>
169
-
<td>
170
-
Base
171
-
</td>
172
-
<td>
173
-
✅
174
-
</td>
175
-
<td>
176
-
✅
177
-
</td>
178
-
<td>
179
-
❌
180
-
</td>
181
-
</tr>
182
168
<tr>
183
169
<td>
184
170
Transient Labs
@@ -202,16 +188,17 @@ Today, Mobile Minting supports the following creator platforms:
202
188
Adding a new platform to Mobile Minting is easy - you just have to write a `MintIngestor`!
203
189
204
190
### MintIngestor functionality
191
+
205
192
A MintIngestor has a simple job:
206
193
207
194
> Transform a URL or contract address into a valid MintTemplate, iff it represents a supported mint by the ingestor
A MintTemplate is a standard format for expressing the details of a mint. It's used to populate the marketing page, pricing, and ultimately fulfill the item onchain.
We recommend consulting example complete ingestor PRs e.g. [#1: Prohibition Daily](https://github.com/floornfts/mobile-minting/pull/1/files).
221
+
222
+
We recommend consulting example complete ingestor PRs e.g. [#65: VV Mint Ingestor](https://github.com/floornfts/mobile-minting/pull/65).
236
223
237
224
You will create a new folder in `src/ingestors` for your new Ingestor.
238
225
@@ -260,49 +247,50 @@ For building the MintTemplate, we recommend using the `MintTemplateBuilder` whic
260
247
261
248
In this example we make a template, relying on `getMintMetadataFromSomewhere()` and `getMintContractDetailsFromSomewhere()` to fetch the marketing & onchain data respectively. We'll touch on those later.
Once you've written a Mobile Minting Ingestor, it needs to be Pull Requested to this repository to be included in the production Rally Mobile Minting ingestion fleet.
354
346
355
347
### Before you submit
348
+
356
349
-[ ] Ensure your generated MintTemplate works 😄
357
350
-[ ] Ensure that your code is restricted to a single folder in `src/ingestors`
358
351
-[ ] Ensure that all required assets are included (e.g. ABIs)
@@ -363,18 +356,18 @@ Once you've written a Mobile Minting Ingestor, it needs to be Pull Requested to
363
356
364
357
### Submitting a Mint Ingestor
365
358
366
-
Open a Pull Request against this repo with your new Ingestor, as well as any comments / questions.
359
+
Open a Pull Request against this repo with your new Ingestor, as well as any comments / questions.
367
360
368
361
We're excited to see new platforms supported, so will quickly jump to help!
369
362
370
363
### Hopes and dreams
364
+
371
365
Mobile Minting started out entirely internal & this is our first experiment in decentralizing it & making it more accessible.
372
366
373
367
In time, we hope to continue down this path, but for now all ingestors will be reviewed by the Rally engineering team & accepted on the basis of safety, cost & other considerations by Rally.
374
368
375
369
We hope to see people (other companies!?) emerge for whom Mobile Minting, and a unified standard for expressing onchain mints is useful, and look forward to working with them to continue this mission.
0 commit comments