Skip to content

Keybase

ratranqu edited this page Apr 26, 2021 · 2 revisions

Keybase

public protocol Keybase 

Requirements

list()

func list() throws -> [KeyInfo]

get(name:​)

func get(name: String) throws -> KeyInfo

getByAddress(address:​)

func getByAddress(address: AccountAddress) throws -> KeyInfo

delete(name:​passphrase:​skipPass:​)

func delete(name: String, passphrase: String, skipPass: Bool) throws

sign(name:​passphrase:​message:​)

func sign(name: String, passphrase: String, message: Data) throws -> (Data, PublicKeyProtocol)

createMnemonic(name:​language:​password:​algorithm:​)

func createMnemonic(
        name: String,
        language: Language,
        password: String,
        algorithm: SigningAlgorithm
    ) throws -> (info: KeyInfo, seed: String)

createAccount(name:​mnemonic:​bip39Password:​encryptPassword:​hdPath:​algorithm:​)

func createAccount(
        name: String,
        mnemonic: String,
        bip39Password: String,
        encryptPassword: String,
        hdPath: String,
        algorithm: SigningAlgorithm
    ) throws -> KeyInfo

createLedger(name:​algorithm:​humanReadablePart:​account:​index:​)

func createLedger(
        name: String,
        algorithm: SigningAlgorithm,
        humanReadablePart: String,
        account: UInt32,
        index: UInt32
    ) throws -> KeyInfo

createOffline(name:​publicKey:​algorithm:​)

func createOffline(
        name: String,
        publicKey: PublicKeyProtocol,
        algorithm: SigningAlgorithm
    ) throws -> KeyInfo

createMulti(name:​publicKey:​)

func createMulti(
        name: String,
        publicKey: PublicKeyProtocol
    ) throws -> KeyInfo

update(name:​oldPassword:​getNewPassword:​)

func update(
        name: String,
        oldPassword: String,
        getNewPassword: () throws -> String
    ) throws

`import`(name:​armor:​)

func `import`(name: String, armor: String) throws

importPrivateKey(name:​armor:​passphrase:​)

func importPrivateKey(
        name: String,
        armor: String,
        passphrase: String
    ) throws

importPublicKey(name:​armor:​)

func importPublicKey(
        name: String,
        armor: String
    ) throws

export(name:​)

func export(name: String) throws -> String

exportPublicKey(name:​)

func exportPublicKey(name: String) throws -> String

exportPrivateKey(name:​decryptPassphrase:​encryptPassphrase:​)

func exportPrivateKey(
        name: String,
        decryptPassphrase: String,
        encryptPassphrase: String
    ) throws -> String

exportPrivateKeyObject(name:​passphrase:​)

func exportPrivateKeyObject(
        name: String,
        passphrase: String
    ) throws -> PrivateKey

supportedAlgorithms

var supportedAlgorithms: [SigningAlgorithm] 

supportedAlgorithmsLedger

var supportedAlgorithmsLedger: [SigningAlgorithm] 

closeDatabase()

func closeDatabase()
Types
Protocols
Global Typealiases
Global Variables
Global Functions
Extensions
Clone this wiki locally