package
10.9.0+incompatible
Repository: https://github.com/status-im/status-go.git
Documentation: pkg.go.dev

# README

Mobile

Package mobile implements gomobile bindings for status-go. Current implementation servers as a drop-in replacement for lib package.

Individual bindings and their descriptions are available in status.go.

The primary consumer of this package is status-mobile project.

The framework name is generated from the package name, hence these things are done intentionally: (1) this package's name isn't equal to the directory name (statusgo vs mobile respectively); (2) this package name is statusgo and not status which produces the right framework name.

Usage

For properly using this package, please refer to Makefile in the root of status-go directory.

To manually build library, run following commands:

iOS

gomobile bind -v -target=ios -ldflags="-s -w" github.com/status-im/status-go/mobile

This will produce Statusgo.framework file in the current directory, which can be used in iOS project.

Android

gomobile bind -v -target=android -ldflags="-s -w" github.com/status-im/status-go/mobile

This will generate Statusgo.aar file in the current dir.

Notes

See https://github.com/golang/go/wiki/Mobile for more information on gomobile usage.

# Packages

No description provided by the author
No description provided by the author

# Functions

No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use AppStateChangeV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use ChangeDatabasePasswordV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use ConnectionChangeV2 instead.
No description provided by the author
Deprecated: Use ConvertToKeycardAccountV2 instead.
No description provided by the author
Deprecated: Use ConvertToRegularAccountV2 instead.
No description provided by the author
No description provided by the author
CreateAccountFromMnemonicAndDeriveAccountsForPaths returns an account derived from the mnemonic phrase and the Bip39Passphrase and generate derived accounts for the list of paths without storing it.
CreateAccountFromPrivateKey returns an account derived from the private key without storing it.
Deprecated: no usage in mobile.
No description provided by the author
Deprecated: Use DeleteImportedKeyV2 instead.
No description provided by the author
Deprecated: Use DeleteMultiaccountV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use EncodeFunctionCallV2 instead.
Deprecated: no usage in mobile, we might implemented it within other functions.
Deprecated: Use EncodeTransferV2 instead.
No description provided by the author
ExportNodeLogs reads current node log and returns content to a caller.
Deprecated: Use ExportUnencryptedDatabaseV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use GenerateImagesV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetPasswordStrength uses zxcvbn module and generates a JSON containing information about the quality of the given password (Entropy, CrackTime, CrackTimeDisplay, Score, MatchSequence and CalcTime).
GetPasswordStrengthScore uses zxcvbn module and gets the score information about the given password.
No description provided by the author
No description provided by the author
No description provided by the author
HashTypedData unmarshalls data into TypedData, validates it and hashes it.
HashTypedDataV4 unmarshalls data into TypedData, validates it and hashes it.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use ImportUnencryptedDatabaseV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use InputConnectionStringForBootstrappingV2 instead.
Deprecated: Use InputConnectionStringForBootstrappingAnotherDeviceV2 instead.
No description provided by the author
No description provided by the author
Deprecated: Use InputConnectionStringForImportingKeypairsKeystoresV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Login loads a key file (for a given address), tries to decrypt it using the password, to verify ownership if verified, purges all the previous identities from Whisper, and injects verified key as shh identity.
No description provided by the author
LoginWithConfig loads a key file (for a given address), tries to decrypt it using the password, to verify ownership if verified, purges all the previous identities from Whisper, and injects verified key as shh identity.
LoginWithKeycard initializes an account with a chat key and encryption key used for PFS.
No description provided by the author
Deprecated: Use MigrateKeyStoreDirV2 instead.
No description provided by the author
MultiAccountDeriveAddresses derive addresses from an account selected by ID, without storing them.
MultiAccountGenerate generates account in memory without storing them.
MultiAccountGenerateAndDeriveAddresses combines Generate and DeriveAddresses in one call.
MultiAccountImportMnemonic imports an account derived from the mnemonic phrase and the Bip39Passphrase storing it.
MultiAccountImportPrivateKey imports a raw private key without storing it.
MultiAccountLoadAccount loads in memory the account specified by address unlocking it with password.
MultiAccountReset remove all the multi-account keys from memory.
MultiAccountStoreAccount stores the select account.
MultiAccountStoreDerivedAccounts derive accounts from the specified key and store them encrypted with the specified password.
Deprecated: Use MultiformatDeserializePublicKeyV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use InitializeApplication instead.
No description provided by the author
No description provided by the author
No description provided by the author
SaveAccountAndLogin saves account in status-go database.
SaveAccountAndLoginWithKeycard saves account in status-go database.
Deprecated: Use SendTransactionV2 instead.
No description provided by the author
SendTransactionWithChainID converts RPC args and calls backend.SendTransactionWithChainID.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SignTypedData unmarshall data into TypedData, validate it and signs with selected account, if password matches selected account.
SignTypedDataV4 unmarshall data into TypedData, validate it and signs with selected account, if password matches selected account.
No description provided by the author
No description provided by the author
StartProfiling starts profiling and HTTP server for pprof.
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: Use SwitchFleetV2 instead.
No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: no usage in mobile.
No description provided by the author
Deprecated: Use ValidateMnemonicV2 instead.
No description provided by the author
No description provided by the author
Deprecated: Use VerifyAccountPasswordV2 instead.
No description provided by the author
Deprecated: use VerifyDatabasePasswordV2 instead.
No description provided by the author
No description provided by the author

# Structs

AccountInfo represents account's info.
APIDetailedResponse represents a generic response with possible errors.
APIError represents a single error.
APIFieldError represents a set of errors related to a parameter.
APIKeyUIDResponse.
APIResponse generic response from API.
No description provided by the author
No description provided by the author
No description provided by the author
MultiAccountDeriveAddressesParams are the params sent to MultiAccountDeriveAddresses.
MultiAccountGenerateAndDeriveAddressesParams are the params sent to MultiAccountGenerateAndDeriveAddresses.
MultiAccountGenerateParams are the params sent to MultiAccountGenerate.
MultiAccountImportMnemonicParams are the params sent to MultiAccountImportMnemonic.
MultiAccountImportPrivateKeyParams are the params sent to MultiAccountImportPrivateKey.
MultiAccountLoadAccountParams are the params sent to MultiAccountLoadAccount.
MultiAccountStoreAccountParams are the params sent to MultiAccountStoreAccount.
MultiAccountStoreDerivedAccountsParams are the params sent to MultiAccountStoreDerivedAccounts.
NotifyResult is a JSON returned from notify message.
OnboardingAccount represents accounts info generated for the onboarding.
No description provided by the author

# Interfaces

SignalHandler defines a minimal interface a signal handler needs to implement.