Skip to content
Merged
Show file tree
Hide file tree
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
437 changes: 437 additions & 0 deletions SECURITY_REVIEW_CLAIMS.md

Large diffs are not rendered by default.

19 changes: 14 additions & 5 deletions docs/api-reference/claims/confirm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,14 +76,17 @@ result = response.json()
The token address that was claimed from
</ResponseField>

<ResponseField name="userTokenAccount" type="string">
The user's associated token account that received the tokens
</ResponseField>

<ResponseField name="claimAmount" type="string">
The amount of tokens that were successfully claimed
</ResponseField>

<ResponseField name="splitRecipients" type="array">
Array of recipients who received tokens from this claim, each containing:
- `wallet` (string): The recipient's wallet address
- `amount` (string): The amount allocated to this recipient
- `label` (string, optional): Description of the recipient (e.g., "Developer")
</ResponseField>

<ResponseField name="confirmation" type="object">
Blockchain confirmation details
</ResponseField>
Expand All @@ -95,8 +98,14 @@ result = response.json()
"success": true,
"transactionSignature": "5VfYiDvQMBSWxKJLa9NLPQ1x3...",
"tokenAddress": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
"userTokenAccount": "ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL",
"claimAmount": "1000000",
"splitRecipients": [
{
"wallet": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"amount": "900000",
"label": "Developer"
}
],
"confirmation": {
"value": {
"err": null
Expand Down
26 changes: 20 additions & 6 deletions docs/api-reference/claims/mint.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,21 @@ result = response.json()
Unique identifier for this transaction (needed for confirmation)
</ResponseField>

<ResponseField name="userTokenAccount" type="string">
The associated token account address where tokens will be minted
</ResponseField>

<ResponseField name="claimAmount" type="string">
The amount of tokens that will be claimed
</ResponseField>

<ResponseField name="splitRecipients" type="array">
Array of recipients who will receive tokens from this claim, each containing:
- `wallet` (string): The recipient's wallet address
- `amount` (string): The amount allocated to this recipient
- `label` (string, optional): Description of the recipient (e.g., "Developer")
</ResponseField>

<ResponseField name="adminAmount" type="string">
The amount allocated to protocol fees (10% of total claim)
</ResponseField>

<ResponseField name="mintDecimals" type="number">
Number of decimal places for the token
</ResponseField>
Expand All @@ -105,9 +112,16 @@ result = response.json()
{
"success": true,
"transaction": "4MzR7dxJNJRVP1Q6k7Y3j8X...",
"transactionKey": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v_9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM_1642248400000",
"userTokenAccount": "ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL",
"transactionKey": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v_1642248400000_a1b2c3d4e5f6g7h8",
"claimAmount": "1000000",
"splitRecipients": [
{
"wallet": "9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM",
"amount": "900000",
"label": "Developer"
}
],
"adminAmount": "100000",
"mintDecimals": 9,
"message": "Sign this transaction and submit to /claims/confirm"
}
Expand Down
Loading