bitbox-api 0.12.0

A library to interact with BitBox hardware wallets
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

// SPDX-License-Identifier: Apache-2.0

syntax = "proto3";
package shiftcrypto.bitbox02;

import "common.proto";

import "backup_commands.proto";
import "bitbox02_system.proto";
import "bluetooth.proto";
import "btc.proto";
import "cardano.proto";
import "eth.proto";
import "keystore.proto";
import "mnemonic.proto";
import "system.proto";

import "perform_attestation.proto";

message Error {
    int32 code = 1;
    string message = 2;
}

message Success {
}

message Request {
    reserved 1, 23;
    oneof request {
        // removed: RandomNumberRequest random_number = 1;
        SetDeviceNameRequest device_name = 2;
        SetDeviceLanguageRequest device_language = 3;
        DeviceInfoRequest device_info = 4;
        SetPasswordRequest set_password = 5;
        CreateBackupRequest create_backup = 6;
        ShowMnemonicRequest show_mnemonic = 7;
        BTCPubRequest btc_pub = 8;
        BTCSignInitRequest btc_sign_init = 9;
        BTCSignInputRequest btc_sign_input = 10;
        BTCSignOutputRequest btc_sign_output = 11;
        InsertRemoveSDCardRequest insert_remove_sdcard = 12;
        CheckSDCardRequest check_sdcard = 13;
        SetMnemonicPassphraseEnabledRequest set_mnemonic_passphrase_enabled = 14;
        ListBackupsRequest list_backups = 15;
        RestoreBackupRequest restore_backup = 16;
        PerformAttestationRequest perform_attestation = 17;
        RebootRequest reboot = 18;
        CheckBackupRequest check_backup = 19;
        ETHRequest eth = 20;
        ResetRequest reset = 21;
        RestoreFromMnemonicRequest restore_from_mnemonic = 22;
        // removed: BitBoxBaseRequest bitboxbase = 23;
        RootFingerprintRequest fingerprint = 24;
        BTCRequest btc = 25;
        ElectrumEncryptionKeyRequest electrum_encryption_key = 26;
        CardanoRequest cardano = 27;
        BIP85Request bip85 = 28;
        BluetoothRequest bluetooth = 29;
        ChangePasswordRequest change_password = 30;
    }
}

message Response {
    reserved 3;
    oneof response {
        Success success = 1;
        Error error = 2;
        // removed: RandomNumberResponse random_number = 3;
        DeviceInfoResponse device_info = 4;
        PubResponse pub = 5;
        BTCSignNextResponse btc_sign_next = 6;
        ListBackupsResponse list_backups = 7;
        CheckBackupResponse check_backup = 8;
        PerformAttestationResponse perform_attestation = 9;
        CheckSDCardResponse check_sdcard = 10;
        ETHResponse eth = 11;
        RootFingerprintResponse fingerprint = 12;
        BTCResponse btc = 13;
        ElectrumEncryptionKeyResponse electrum_encryption_key = 14;
        CardanoResponse cardano = 15;
        BIP85Response bip85 = 16;
        BluetoothResponse bluetooth = 17;
    }
}