code

Documentation

Overview

Package code defines return codes for the Nym application

Index

• Constants
• func ToString(code uint32) string

Constants

const (

	// OK represents a success.
	OK uint32 = 0
	// UNKNOWN represents a failure due to unknown causes.
	UNKNOWN uint32 = 1
	// INVALID_TX_LENGTH represents error due to tx having unexpected length.
	INVALID_TX_LENGTH uint32 = 2
	// INVALID_TX_PARAMS represents error due to tx having incorrect attributes embedded.
	INVALID_TX_PARAMS uint32 = 3
	// INVALID_QUERY_PARAMS represents error due to query having incorrect attributes embedded.
	INVALID_QUERY_PARAMS uint32 = 4
	// ACCOUNT_DOES_NOT_EXIST represents error due to trying to interact with an account that does not exist.
	ACCOUNT_DOES_NOT_EXIST uint32 = 5
	// INSUFFICIENT_BALANCE represents error due to an account having insufficient funds for the desired operation.
	INSUFFICIENT_BALANCE uint32 = 6
	// INVALID_CREDENTIAL represents error due to failing to verify credential.
	INVALID_CREDENTIAL uint32 = 7
	// INVALID_SIGNATURE represents error due to failing to verify signature.
	INVALID_SIGNATURE uint32 = 8
	// INVALID_MERCHANT_ADDRESS represents error due to malformed merchant address.
	INVALID_MERCHANT_ADDRESS uint32 = 9
	// MERCHANT_DOES_NOT_EXIST represents error when trying to spend credential at non-existing merchant.
	// Only applicable if system is set to not create accounts for non-existent merchants.
	MERCHANT_DOES_NOT_EXIST uint32 = 10
	// ISSUING_AUTHORITY_DOES_NOT_EXIST represents error when trying to verify credential/signature with IA that
	// is not known by the abci
	ISSUING_AUTHORITY_DOES_NOT_EXIST uint32 = 11
	// MALFORMED_ADDRESS represents error due to address being malformed (incorrect length, incorrect prefix, etc)
	MALFORMED_ADDRESS = 12
	// DOUBLE_SPENDING_ATTEMPT represents error due to trying to spend credential with the same sequence number
	DOUBLE_SPENDING_ATTEMPT = 13
	// SELF_TRANSFER represents error when trying to send funds from account X back to account X
	SELF_TRANSFER = 14
	// REPLAY_ATTACK_ATTEMPT represents error due to trying to transfer tokens
	// to the pipe account with repeating same nonce.
	REPLAY_ATTACK_ATTEMPT = 15
	// UNDEFINED_TX represents error due to using tx prefix for an undefined tx.
	UNDEFINED_TX = 16
	// ETHEREUM_WATCHER_DOES_NOT_EXIST represents error when trying to verify signature signed by an unknown watcher
	ETHEREUM_WATCHER_DOES_NOT_EXIST uint32 = 17
	// ALREADY_CONFIRMED represents error when some entity, like the watcher,
	// sends same event confirmation multiple times
	ALREADY_CONFIRMED uint32 = 18
	// MALFORMED_PUBLIC_KEY represents error when some entity presents a malformed public key, for example by having
	// invalid length or structure (or can't be unmarshalled)
	MALFORMED_PUBLIC_KEY = 19
	// ALREADY_COMMITTED represents error when watcher wants to notify about transaction
	// while a threshold number of watchers already sent their notifications
	ALREADY_COMMITTED = 20
	// INVALID_PIPE_ACCOUNT represents error due to using different than specified address of the pipe account
	INVALID_PIPE_ACCOUNT = 21
	// INVALID_VALUE represents error due to credential request (or possibly transfer) having an invalid value
	INVALID_VALUE = 22
	// COULD_NOT_TRANSFER represents a generic error for failing to transfer funds between accounts.
	COULD_NOT_TRANSFER uint32 = 100 // todo: replace occurrences with more specific errors
)

TODO: reorder and group codes in a more logical way (currently they're added as needed) nolint: golint

Functions

func ToString

func ToString(code uint32) string

ToString returns string representation of the return code. It is useful for making human-readable responses. nolint: gocyclo