Building User-Level Approvals

User-level approvals allow individual users to control their token transfers through incoming and outgoing approvals. These work similarly to collection-level approvals with key restrictions.

We refer you to the collection-level examples and just apply the same logic to the user-level types with these differences.

Key Differences from Collection Approvals

• Fixed Address Lists:

  • Incoming approvals: fromListId is locked to the user's address

  • Outgoing approvals: toListId is locked to the user's address

• No Override Functionality: Cannot override other approval levels

• User-Controlled: Only the user can update their own approvals

Incoming Approvals

Control what tokens the user can receive:

const userIncomingApproval = {
    fromListId: 'user-address', // Locked to approver's address
    toListId: 'All', // Can specify recipients
    initiatedByListId: 'All',
    transferTimes: [{ start: '1', end: '18446744073709551615' }],
    tokenIds: [{ start: '1', end: '100' }],
    ownershipTimes: [{ start: '1', end: '18446744073709551615' }],
    approvalId: 'user-incoming-approval',

    // Use any approval criteria from collection examples
    approvalCriteria: {
        // See: transferable-approval.md, burnable-approval.md, etc.
        // OR use EmptyApprovalCriteria for no restrictions
        ...EmptyApprovalCriteria,
    },
};

Outgoing Approvals

Control what tokens the user can send:

const userOutgoingApproval = {
    fromListId: 'All', // Can specify senders
    toListId: 'user-address', // Locked to approver's address
    initiatedByListId: 'All',
    transferTimes: [{ start: '1', end: '18446744073709551615' }],
    tokenIds: [{ start: '1', end: '100' }],
    ownershipTimes: [{ start: '1', end: '18446744073709551615' }],
    approvalId: 'user-outgoing-approval',

    // Use any approval criteria from collection examples
    approvalCriteria: {
        // See: transferable-approval.md, burnable-approval.md, etc.
        // OR use EmptyApprovalCriteria for no restrictions
        ...EmptyApprovalCriteria,
    },
};

Implementation

Users update their approvals via MsgUpdateUserApprovals:

const updateUserApprovals = {
    creator: 'bb1...', // Your address
    collectionId: '1',
    updateIncomingApprovals: true,
    incomingApprovals: [userIncomingApproval],
    updateOutgoingApprovals: true,
    outgoingApprovals: [userOutgoingApproval],
    // ...
};

Reference

For approval criteria examples, see:

• Empty Approval Criteria - No restrictions template

• Transferable Approval - Basic transfer restrictions

• Burnable Approval - Burn functionality

• Address Checks - Address type restrictions

• Building Collection Approvals - Collection-level patterns

For concepts, see:

• Transferability

• Approval Criteria