address_book_entrypoints.h

Go to the documentation of this file.

/*******************************************************************************
 *   (c) 2026 Ledger SAS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 ********************************************************************************/
#pragma once
 
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include "identity.h"
#include "nbgl_use_case.h"
 
#ifdef HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT
#include "ledger_account.h"
#endif
 
/*
The handle functions must be defined by each Coin application implementing the Address Book feature.
 
These functions will be called by the common code of the Address Book application
in order to validate the content of the payload, or finalize/cleanup the UI flow.
*/
 
#ifdef HAVE_ADDRESS_BOOK
 
/*************** Exported functions prototypes: Register Identity **************/
 
bool handle_check_register_identity(identity_t *params);
 
void finalize_ui_register_identity(void);
 
nbgl_contentTagValue_t *get_register_identity_tagValue(uint8_t pairIndex);
 
/*************** Exported functions prototypes: Edit Contact Name **************/
 
void finalize_ui_edit_contact_name(void);
 
void on_edit_contact_name_applied(const edit_contact_name_t *edit);
 
/*************** Exported functions prototypes: Edit Identifier ***************/
 
bool handle_check_edit_identifier(const edit_identifier_t *params);
 
nbgl_contentTagValue_t *get_edit_identifier_tagValue(uint8_t pairIndex);
 
void finalize_ui_edit_identifier(void);
 
void on_edit_identifier_applied(const edit_identifier_t *edit);
 
/*************** Exported functions prototypes: Edit Scope ****************/
 
void finalize_ui_edit_scope(void);
 
void on_edit_scope_applied(const edit_scope_t *edit);
 
/*************** Exported functions prototypes: Provide Contact ***********/
 
bool handle_provide_identity(const identity_t *contact);
 
#ifdef HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT
 
/*************** Exported functions prototypes: Ledger Account *****************/
 
bool handle_check_register_ledger_account(ledger_account_t *params);
 
void display_register_ledger_account_review(nbgl_choiceCallback_t choice_callback);
 
void finalize_ui_register_ledger_account(void);
 
/*************** Exported functions prototypes: Edit Ledger Account **********/
 
bool handle_check_edit_ledger_account(edit_ledger_account_t *params);
 
void finalize_ui_edit_ledger_account(void);
 
void on_edit_ledger_account_applied(const edit_ledger_account_t *edit);
 
/*************** Exported functions prototypes: Provide Ledger Account Contact */
 
bool handle_provide_ledger_account(const ledger_account_t *account);
 
#endif  // HAVE_ADDRESS_BOOK_LEDGER_ACCOUNT
 
#endif  // HAVE_ADDRESS_BOOK