Skip to content

API.md

Latest commit

 

History

History
888 lines (561 loc) · 56.8 KB

API.md

File metadata and controls

888 lines (561 loc) · 56.8 KB

Summary

Members Descriptions
define BUFFER_SIZE
define STRING_SIZE
define JSON_FILE_SIZE
define JSON_BIG_FILE_SIZE
define FILEPATH_SEPARATOR
define TEST_DATA_DIR
define MANY_ADDRESSES_FILENAME
define INPUT_HASHES_FILENAME
define SEED_FILE_REGEX
define json_char
define json_int_t
define json_enable_comments
define json_error_max
define GO_CGO_EXPORT_PROLOGUE_H
define GO_CGO_PROLOGUE_H
define SKY_OK
define SKY_ERROR
enum json_type
public unsigned int b64_int(unsigned int ch)
public unsigned int b64e_size(unsigned int in_size)
public unsigned int b64d_size(unsigned int in_size)
public unsigned int b64_encode(const unsigned char * in,unsigned int in_len,unsigned char * out)
public unsigned int b64_decode(const unsigned char * in,unsigned int in_len,unsigned char * out)
public unsigned int b64_encodef(char * InFile,char * OutFile)
public unsigned int b64_decodef(char * InFile,char * OutFile)
public json_value*loadGoldenFile(const char * file)
public InputTestDataJSON*jsonToInputTestData(json_value * json,InputTestDataJSON * input_data)
public InputTestData*registerInputTestDataCleanup(InputTestData * input_data)
public InputTestDataJSON*registerInputTestDataJSONCleanup(InputTestDataJSON * input_data)
public void InputTestDataToJSON(InputTestData * input_data,InputTestDataJSON * json_data)
public GoUint32 InputTestDataFromJSON(InputTestDataJSON * json_data,InputTestData * input_data)
public KeysTestDataJSON*jsonToKeysTestData(json_value * json,KeysTestDataJSON * input_data)
public KeysTestData*registerKeysTestDataCleanup(KeysTestData * input_data)
public KeysTestDataJSON*registerKeysTestDataJSONCleanup(KeysTestDataJSON * input_data)
public void KeysTestDataToJson(KeysTestData * input_data,KeysTestDataJSON * json_data)
public GoUint32 KeysTestDataFromJSON(KeysTestDataJSON * json_data,KeysTestData * input_data)
public SeedTestDataJSON*jsonToSeedTestData(json_value * json,SeedTestDataJSON * input_data)
public SeedTestData*registerSeedTestDataCleanup(SeedTestData * input_data)
public SeedTestDataJSON*registerSeedTestDataJSONCleanup(SeedTestDataJSON * input_data)
public void SeedTestDataToJson(SeedTestData * input_data,SeedTestDataJSON * json_data)
public GoUint32 SeedTestDataFromJSON(SeedTestDataJSON * json_data,SeedTestData * input_data)
public void ValidateSeedData(SeedTestData * seedData,InputTestData * inputData)
public json_value*json_parse(const json_char * json,size_t length)
public json_value*json_parse_ex(json_settings * settings,const json_char * json,size_t length,char * error)
public void json_value_free(json_value *)
public void json_value_free_ex(json_settings * settings,json_value *)
public int DecodeBase58Address(GoString p0,Address * p1)
public int cr_user_cipher__Address_eq(cipher__Address * addr1,cipher__Address * addr2)
public char * cr_user_cipher__Address_tostr(cipher__Address * addr1)
public int cr_user_cipher__Address_noteq(cipher__Address * addr1,cipher__Address * addr2)
public int cr_user_GoString_eq(GoString * string1,GoString * string2)
public int cr_user_GoString__eq(GoString_ * string1,GoString_ * string2)
public char * cr_user_GoString_tostr(GoString * string)
public char * cr_user_GoString__tostr(GoString_ * string)
public int cr_user_cipher__SecKey_eq(cipher__SecKey * seckey1,cipher__SecKey * seckey2)
public char * cr_user_cipher__SecKey_tostr(cipher__SecKey * seckey1)
public int cr_user_cipher__Ripemd160_noteq(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)
public int cr_user_cipher__Ripemd160_eq(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)
public char * cr_user_cipher__Ripemd160_tostr(cipher__Ripemd160 * rp1)
public int cr_user_GoSlice_eq(GoSlice * slice1,GoSlice * slice2)
public char * cr_user_GoSlice_tostr(GoSlice * slice1)
public int cr_user_GoSlice_noteq(GoSlice * slice1,GoSlice * slice2)
public int cr_user_cipher__SHA256_noteq(cipher__SHA256 * sh1,cipher__SHA256 * sh2)
public int cr_user_cipher__SHA256_eq(cipher__SHA256 * sh1,cipher__SHA256 * sh2)
public char * cr_user_cipher__SHA256_tostr(cipher__SHA256 * sh1)
public void randBytes(GoSlice * bytes,size_t n)
public void strnhex(unsigned char * buf,char * str,int n)
public void strhex(unsigned char * buf,char * str)
public void fprintbuff(FILE * f,void * buff,size_t n)
public json_value*loadJsonFile(const char * filename)
public void * registerMemCleanup(void * p)
public void toGoString(GoString_ * s,GoString * r)
public json_value*json_get_string(json_value * value,const char * key)
public int json_set_string(json_value * value,const char * new_string_value)
public int registerJsonFree(void * p)
public void freeRegisteredJson(void * p)
public int compareJsonValues(json_value * value1,json_value * value2)
public json_value*get_json_value(json_value * node,const char * path,json_type type)
public json_value*get_json_value_not_strict(json_value * node,const char * path,json_type type,int allow_null)
public void setup(void)
public void teardown(void)
struct _GoString_
struct _json_object_entry
struct _json_value
struct Address
struct cipher__Address Addresses of SKY accounts
struct cipher__BitcoinAddress Addresses of Bitcoin accounts
struct cli__SendAmount Structure used to specify amounts transferred in a transaction.
struct coin__Transaction Skycoin transaction.
struct coin__TransactionOutput Skycoin transaction output.
struct coin__UxBody
struct coin__UxHead
struct coin__UxOut
struct GoInterface
struct GoInterface_ Instances of Go interface types.
struct GoSlice
struct GoSlice_ Instances of Go slices
struct GoString_ Instances of Go string type.
struct InputTestData
struct InputTestDataJSON
struct json_settings
struct KeysTestData
struct KeysTestDataJSON
struct SeedTestData
struct SeedTestDataJSON
struct wallet__Entry Wallet entry.
struct wallet__UxBalance Intermediate representation of a UxOut for sorting and spend choosing.
struct wallet__Wallet Internal representation of a Skycoin wallet.

Members

define BUFFER_SIZE

define STRING_SIZE

define JSON_FILE_SIZE

define JSON_BIG_FILE_SIZE

define FILEPATH_SEPARATOR

define TEST_DATA_DIR

define MANY_ADDRESSES_FILENAME

define INPUT_HASHES_FILENAME

define SEED_FILE_REGEX

define json_char

define json_int_t

define json_enable_comments

define json_error_max

define GO_CGO_EXPORT_PROLOGUE_H

define GO_CGO_PROLOGUE_H

define SKY_OK

define SKY_ERROR

enum json_type

Values Descriptions
json_none
json_object
json_array
json_integer
json_double
json_string
json_boolean
json_null

public unsigned int b64_int(unsigned int ch)

public unsigned int b64e_size(unsigned int in_size)

public unsigned int b64d_size(unsigned int in_size)

public unsigned int b64_encode(const unsigned char * in,unsigned int in_len,unsigned char * out)

public unsigned int b64_decode(const unsigned char * in,unsigned int in_len,unsigned char * out)

public unsigned int b64_encodef(char * InFile,char * OutFile)

public unsigned int b64_decodef(char * InFile,char * OutFile)

public json_value*loadGoldenFile(const char * file)

public InputTestDataJSON*jsonToInputTestData(json_value * json,InputTestDataJSON * input_data)

public InputTestData*registerInputTestDataCleanup(InputTestData * input_data)

public InputTestDataJSON*registerInputTestDataJSONCleanup(InputTestDataJSON * input_data)

public void InputTestDataToJSON(InputTestData * input_data,InputTestDataJSON * json_data)

public GoUint32 InputTestDataFromJSON(InputTestDataJSON * json_data,InputTestData * input_data)

public KeysTestDataJSON*jsonToKeysTestData(json_value * json,KeysTestDataJSON * input_data)

public KeysTestData*registerKeysTestDataCleanup(KeysTestData * input_data)

public KeysTestDataJSON*registerKeysTestDataJSONCleanup(KeysTestDataJSON * input_data)

public void KeysTestDataToJson(KeysTestData * input_data,KeysTestDataJSON * json_data)

public GoUint32 KeysTestDataFromJSON(KeysTestDataJSON * json_data,KeysTestData * input_data)

public SeedTestDataJSON*jsonToSeedTestData(json_value * json,SeedTestDataJSON * input_data)

public SeedTestData*registerSeedTestDataCleanup(SeedTestData * input_data)

public SeedTestDataJSON*registerSeedTestDataJSONCleanup(SeedTestDataJSON * input_data)

public void SeedTestDataToJson(SeedTestData * input_data,SeedTestDataJSON * json_data)

public GoUint32 SeedTestDataFromJSON(SeedTestDataJSON * json_data,SeedTestData * input_data)

public void ValidateSeedData(SeedTestData * seedData,InputTestData * inputData)

public json_value*json_parse(const json_char * json,size_t length)

public json_value*json_parse_ex(json_settings * settings,const json_char * json,size_t length,char * error)

public void json_value_free(json_value *)

public void json_value_free_ex(json_settings * settings,json_value *)

public int DecodeBase58Address(GoString p0,Address * p1)

public int cr_user_cipher__Address_eq(cipher__Address * addr1,cipher__Address * addr2)

public char * cr_user_cipher__Address_tostr(cipher__Address * addr1)

public int cr_user_cipher__Address_noteq(cipher__Address * addr1,cipher__Address * addr2)

public int cr_user_GoString_eq(GoString * string1,GoString * string2)

public int cr_user_GoString__eq(GoString_ * string1,GoString_ * string2)

public char * cr_user_GoString_tostr(GoString * string)

public char * cr_user_GoString__tostr(GoString_ * string)

public int cr_user_cipher__SecKey_eq(cipher__SecKey * seckey1,cipher__SecKey * seckey2)

public char * cr_user_cipher__SecKey_tostr(cipher__SecKey * seckey1)

public int cr_user_cipher__Ripemd160_noteq(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)

public int cr_user_cipher__Ripemd160_eq(cipher__Ripemd160 * rp1,cipher__Ripemd160 * rp2)

public char * cr_user_cipher__Ripemd160_tostr(cipher__Ripemd160 * rp1)

public int cr_user_GoSlice_eq(GoSlice * slice1,GoSlice * slice2)

public char * cr_user_GoSlice_tostr(GoSlice * slice1)

public int cr_user_GoSlice_noteq(GoSlice * slice1,GoSlice * slice2)

public int cr_user_cipher__SHA256_noteq(cipher__SHA256 * sh1,cipher__SHA256 * sh2)

public int cr_user_cipher__SHA256_eq(cipher__SHA256 * sh1,cipher__SHA256 * sh2)

public char * cr_user_cipher__SHA256_tostr(cipher__SHA256 * sh1)

public void randBytes(GoSlice * bytes,size_t n)

public void strnhex(unsigned char * buf,char * str,int n)

public void strhex(unsigned char * buf,char * str)

public void fprintbuff(FILE * f,void * buff,size_t n)

public json_value*loadJsonFile(const char * filename)

public void * registerMemCleanup(void * p)

public void toGoString(GoString_ * s,GoString * r)

public json_value*json_get_string(json_value * value,const char * key)

public int json_set_string(json_value * value,const char * new_string_value)

public int registerJsonFree(void * p)

public void freeRegisteredJson(void * p)

public int compareJsonValues(json_value * value1,json_value * value2)

public json_value*get_json_value(json_value * node,const char * path,json_type type)

public json_value*get_json_value_not_strict(json_value * node,const char * path,json_type type,int allow_null)

public void setup(void)

public void teardown(void)

struct _GoString_

Summary

Members Descriptions
public const char * p
public ptrdiff_t n

Members

public const char * p

public ptrdiff_t n

struct _json_object_entry

Summary

Members Descriptions
public json_char * name
public unsigned int name_length
public struct _json_value*value

Members

public json_char * name

public unsigned int name_length

public struct _json_value*value

struct _json_value

Summary

Members Descriptions
public struct _json_value*parent
public json_type type
public int boolean
public json_int_t integer
public double dbl
public unsigned int length
public json_char * ptr
public struct _json_value::@0::@2 string
public json_object_entry*values
public struct _json_value::@0::@3 object
public struct _json_value**values
public struct _json_value::@0::@4 array
public union _json_value::@0 u
public struct _json_value*next_alloc
public void * object_mem
public union _json_value::@1 _reserved

Members

public struct _json_value*parent

public json_type type

public int boolean

public json_int_t integer

public double dbl

public unsigned int length

public json_char * ptr

public struct _json_value::@0::@2 string

public json_object_entry*values

public struct _json_value::@0::@3 object

public struct _json_value**values

public struct _json_value::@0::@4 array

public union _json_value::@0 u

public struct _json_value*next_alloc

public void * object_mem

public union _json_value::@1 _reserved

struct Address

Summary

Members Descriptions
public unsigned char Version
public Ripemd160 Key

Members

public unsigned char Version

public Ripemd160 Key

struct cipher__Address

Addresses of SKY accounts

Summary

Members Descriptions
public unsigned char Version Address version identifier. Used to differentiate testnet vs mainnet addresses, for instance.
public cipher__Ripemd160 Key Address hash identifier.

Members

public unsigned char Version

Address version identifier. Used to differentiate testnet vs mainnet addresses, for instance.

public cipher__Ripemd160 Key

Address hash identifier.

struct cipher__BitcoinAddress

Addresses of Bitcoin accounts

Summary

Members Descriptions
public unsigned char Version Address version identifier. Used to differentiate testnet vs mainnet addresses, for instance.
public cipher__Ripemd160 Key Address hash identifier.

Members

public unsigned char Version

Address version identifier. Used to differentiate testnet vs mainnet addresses, for instance.

public cipher__Ripemd160 Key

Address hash identifier.

struct cli__SendAmount

Structure used to specify amounts transferred in a transaction.

Summary

Members Descriptions
public GoString_ Addr Sender / receipient address.
public GoInt64_ Coins Amount transferred (e.g. measured in SKY)

Members

public GoString_ Addr

Sender / receipient address.

public GoInt64_ Coins

Amount transferred (e.g. measured in SKY)

struct coin__Transaction

Skycoin transaction.

Instances of this struct are included in blocks.

Summary

Members Descriptions
public GoInt32_ Length Current transaction's length expressed in bytes.
public GoInt8_ Type Transaction's version. When a node tries to process a transaction, it must verify whether it supports the transaction's type. This is intended to provide a way to update skycoin clients and servers without crashing the network. If the transaction is not compatible with the node, it should not process it.
public cipher__SHA256 InnerHash It's a SHA256 hash of the inputs and outputs of the transaction. It is used to protect against transaction mutability. This means that the transaction cannot be altered after its creation.
public GoSlice_ Sigs A list of digital signiatures generated by the skycoin client using the private key. It is used by Skycoin servers to verify the authenticy of the transaction. Each input requires a different signature.
public GoSlice_ In A list of references to unspent transaction outputs. Unlike other cryptocurrencies, such as Bitcoin, Skycoin unspent transaction outputs (UX) and Skycoin transactions (TX) are separated in the blockchain protocol, allowing for lighter transactions, thus reducing the broadcasting costs across the network.
public GoSlice_ Out Outputs: A list of outputs created by the client, that will be recorded in the blockchain if transactions are confirmed. An output consists of a data structure representing an UTXT, which is composed by a Skycoin address to be sent to, the amount in Skycoin to be sent, and the amount of Coin Hours to be sent, and the SHA256 hash of the previous fields.

Members

public GoInt32_ Length

Current transaction's length expressed in bytes.

public GoInt8_ Type

Transaction's version. When a node tries to process a transaction, it must verify whether it supports the transaction's type. This is intended to provide a way to update skycoin clients and servers without crashing the network. If the transaction is not compatible with the node, it should not process it.

public cipher__SHA256 InnerHash

It's a SHA256 hash of the inputs and outputs of the transaction. It is used to protect against transaction mutability. This means that the transaction cannot be altered after its creation.

public GoSlice_ Sigs

A list of digital signiatures generated by the skycoin client using the private key. It is used by Skycoin servers to verify the authenticy of the transaction. Each input requires a different signature.

public GoSlice_ In

A list of references to unspent transaction outputs. Unlike other cryptocurrencies, such as Bitcoin, Skycoin unspent transaction outputs (UX) and Skycoin transactions (TX) are separated in the blockchain protocol, allowing for lighter transactions, thus reducing the broadcasting costs across the network.

public GoSlice_ Out

Outputs: A list of outputs created by the client, that will be recorded in the blockchain if transactions are confirmed. An output consists of a data structure representing an UTXT, which is composed by a Skycoin address to be sent to, the amount in Skycoin to be sent, and the amount of Coin Hours to be sent, and the SHA256 hash of the previous fields.

struct coin__TransactionOutput

Skycoin transaction output.

Instances are integral part of transactions included in blocks.

Summary

Members Descriptions
public cipher__Address Address Receipient address.
public GoInt64_ Coins Amount sent to the receipient address.
public GoInt64_ Hours Amount of Coin Hours sent to the receipient address.

Members

public cipher__Address Address

Receipient address.

public GoInt64_ Coins

Amount sent to the receipient address.

public GoInt64_ Hours

Amount of Coin Hours sent to the receipient address.

struct coin__UxBody

Summary

Members Descriptions
public cipher__SHA256 SrcTransaction
public cipher__Address Address
public GoUint64_ Coins
public GoUint64_ Hours

Members

public cipher__SHA256 SrcTransaction

public cipher__Address Address

public GoUint64_ Coins

public GoUint64_ Hours

struct coin__UxHead

Summary

Members Descriptions
public GoUint64_ Time
public GoUint64_ BkSeq

Members

public GoUint64_ Time

public GoUint64_ BkSeq

struct coin__UxOut

Summary

Members Descriptions
public coin__UxHead Head
public coin__UxBody Body

Members

public coin__UxHead Head

public coin__UxBody Body

struct GoInterface

Summary

Members Descriptions
public void * t
public void * v

Members

public void * t

public void * v

struct GoInterface_

Instances of Go interface types.

Summary

Members Descriptions
public void * t Pointer to the information of the concrete Go type bound to this interface reference.
public void * v Pointer to the data corresponding to the value bound to this interface type.

Members

public void * t

Pointer to the information of the concrete Go type bound to this interface reference.

public void * v

Pointer to the data corresponding to the value bound to this interface type.

struct GoSlice

Summary

Members Descriptions
public void * data
public GoInt len
public GoInt cap

Members

public void * data

public GoInt len

public GoInt cap

struct GoSlice_

Instances of Go slices

Summary

Members Descriptions
public void * data Pointer to buffer containing slice data.
public GoInt_ len Number of items stored in slice buffer.
public GoInt_ cap Maximum number of items that fits in this slice considering allocated memory and item type's size.

Members

public void * data

Pointer to buffer containing slice data.

public GoInt_ len

Number of items stored in slice buffer.

public GoInt_ cap

Maximum number of items that fits in this slice considering allocated memory and item type's size.

struct GoString_

Instances of Go string type.

Summary

Members Descriptions
public const char * p Pointer to string characters buffer.
public GoInt_ n String size not counting trailing \0 char if at all included.

Members

public const char * p

Pointer to string characters buffer.

public GoInt_ n

String size not counting trailing \0 char if at all included.

struct InputTestData

Summary

Members Descriptions
public GoSlice Hashes

Members

public GoSlice Hashes

struct InputTestDataJSON

Summary

Members Descriptions
public GoSlice Hashes

Members

public GoSlice Hashes

struct json_settings

Summary

Members Descriptions
public unsigned long max_memory
public int settings
public void *(* mem_alloc
public void(* mem_free
public void * user_data
public size_t value_extra

Members

public unsigned long max_memory

public int settings

public void *(* mem_alloc

public void(* mem_free

public void * user_data

public size_t value_extra

struct KeysTestData

Summary

Members Descriptions
public cipher__Address Address
public cipher__SecKey Secret
public cipher__PubKey Public
public GoSlice Signatures

Members

public cipher__Address Address

public cipher__SecKey Secret

public cipher__PubKey Public

public GoSlice Signatures

struct KeysTestDataJSON

Summary

Members Descriptions
public GoString Address
public GoString Secret
public GoString Public
public GoSlice Signatures

Members

public GoString Address

public GoString Secret

public GoString Public

public GoSlice Signatures

struct SeedTestData

Summary

Members Descriptions
public GoSlice Seed
public GoSlice Keys

Members

public GoSlice Seed

public GoSlice Keys

struct SeedTestDataJSON

Summary

Members Descriptions
public GoString Seed
public GoSlice Keys

Members

public GoString Seed

public GoSlice Keys

struct wallet__Entry

Wallet entry.

Summary

Members Descriptions
public cipher__Address Address Wallet address.
public cipher__PubKey Public Public key used to generate address.
public cipher__SecKey Secret Secret key used to generate address.

Members

public cipher__Address Address

Wallet address.

public cipher__PubKey Public

Public key used to generate address.

public cipher__SecKey Secret

Secret key used to generate address.

struct wallet__UxBalance

Intermediate representation of a UxOut for sorting and spend choosing.

Summary

Members Descriptions
public cipher__SHA256 Hash Hash of underlying UxOut.
public GoInt64_ BkSeq moment balance calculation is performed at.
public cipher__Address Address Account holder address.
public GoInt64_ Coins Coins amount (e.g. in SKY).
public GoInt64_ Hours Balance of Coin Hours generated by underlying UxOut, depending on UxOut's head time.

Members

public cipher__SHA256 Hash

Hash of underlying UxOut.

public GoInt64_ BkSeq

moment balance calculation is performed at.

Block height corresponding to the

public cipher__Address Address

Account holder address.

public GoInt64_ Coins

Coins amount (e.g. in SKY).

public GoInt64_ Hours

Balance of Coin Hours generated by underlying UxOut, depending on UxOut's head time.

struct wallet__Wallet

Internal representation of a Skycoin wallet.

Summary

Members Descriptions
public GoMap_ Meta Records items that are not deterministic, like filename, lable, wallet type, secrets, etc.
public GoSlice_ Entries Entries field stores the address entries that are deterministically generated from seed.

Members

public GoMap_ Meta

Records items that are not deterministic, like filename, lable, wallet type, secrets, etc.

public GoSlice_ Entries

Entries field stores the address entries that are deterministically generated from seed.

Generated by Moxygen