kmdgo

I created this Go package as part of my learning process of Go language. This as of this stage is working to for the basic things required, like just using the "methods" with "parameters" and it will give you the expected result in Go's native data set, structs, which you can use further to code your application. Would really appreciate if any other experienced Go language developers may push any improvements of fixes required for this package.

As of this stage, this package is compatible with Komodo and all of it's Assetchains.

Documentation and Examples

Godoc link: https://godoc.org/github.com/satindergrewal/kmdgo/
Examples: Each API call has it's own example file created under examples directory.

Install dependencies and setup environemnt

This package depends on saplinglib, so you have to get that package and set environment variables.

For Linux setup these environment variables:

export CGO_CFLAGS="-I$HOME/go/src/github.com/satindergrewal/saplinglib/src/"
export CGO_LDFLAGS="-L$HOME/go/src/github.com/satindergrewal/saplinglib/dist/linux -lsaplinglib -lpthread -ldl -lm"

For macOS x86_64 setup these environment variables:

export CGO_CFLAGS="-I$HOME/go/src/github.com/satindergrewal/saplinglib/src/"
export CGO_LDFLAGS="-L$HOME/go/src/github.com/satindergrewal/saplinglib/dist/darwin -lsaplinglib -framework Security"

For macOS arm64 setup these environment variables:

export CGO_CFLAGS="-I$HOME/go/src/github.com/satindergrewal/saplinglib/src/"
export CGO_LDFLAGS="-L$HOME/go/src/github.com/satindergrewal/saplinglib/dist/darwin_arm64/ -lsaplinglib -framework Security"

For MingW cross-platform windows setup these environment variables:

export CGO_CFLAGS="-I$HOME/go/src/github.com/satindergrewal/saplinglib/src/"
export CGO_LDFLAGS="-L$HOME/go/src/github.com/satindergrewal/saplinglib/dist/win64 -lsaplinglib -lws2_32 -luserenv"
export CC="x86_64-w64-mingw32-gcc"

Install dependency:

go get -u github.com/satindergrewal/saplinglib

Quick Example

To use this package do

go get -u github.com/satindergrewal/kmdgo

Example code:

//main.go
package main

import (
	"fmt"
	"github.com/satindergrewal/kmdgo/kmdutil"
)

func main() {
	appName := "VRSC"
	dir := kmdutil.AppDataDir(appName, false)
	fmt.Println(dir)

	rpcuser, rpcpass, rpcport := kmdutil.AppRPCInfo(appName)
	fmt.Printf("RPC User: %s\nRPC Password: %s\nRPC Port: %s\n", rpcuser, rpcpass, rpcport)
}

Output:

$ go run main.go
/home/satinder/.komodo/VRSC
RPC User: user1773837506
RPC Password: passbae43ecd576o8ariotkgjhasdfiyosidulrkhdf9390bf03b68
RPC Port: 27486

Supported API Calls

KMDUtil Specific Methods

AppDataDir - Gives the path of cryptocurrency's Data directory based on it's symbol. Supports Only Komodo and Assetchains so far.
AppRPCInfo - Provides RPC username, password and it's port by reading it's config file from data directory.
GetTAddress - GetTAddress generates a public address using a seed phrase
GetZAddress - GetZAddress generates a shielded sapling address using a seed phrase
GetIguanaWallet - GetIguanaWallet returns a set of public and shielded addresses generated based on a mnemonic seed phrase
BytesToString - BytesToString converts and returns bytes to string

NOTE: saplinglib is required for kmdutil methods `GetZAddress` and `GetIguanaWallet`

CClib

cclib method [evalcode] [JSON params]
cclibaddress [evalcode] [pubkey]
cclibinfo

DEX

FSM

FSMaddress [pubkey]
FSMcreate name states
FSMinfo fundingtxid
FSMlist

Addressindex

Auction

auctionaddress [pubkey]

Blockchain

Channels

channelsaddress destpubkey
channelsclose opentxid
channelsinfo [opentxid]
channelsinfo
channelsopen destpubkey numpayments payment
channelspayment opentxid amount [secret]
channelsrefund opentxid closetxid

Control

getinfo
help ( "command" )
stop

Crosschain

MoMoMdata symbol kmdheight ccid
assetchainproof needs a txid
calc_MoM height MoMdepth
getNotarisationsForBlock blockHash
height_MoM height
migrate_completeimporttransaction importTx
migrate_converttoexport rawTx dest_symbol export_amount
migrate_createimporttransaction burnTx payouts
scanNotarisationsDB blockHeight symbol [blocksLimit=1440]

Dice

diceaddfunds name fundingtxid amount
diceaddress [pubkey]
dicebet name fundingtxid amount odds
dicefinish name fundingtxid bettxid
dicefund name funds minbet maxbet maxodds timeoutblocks
diceinfo fundingtxid
dicelist
dicestatus name fundingtxid bettxid

Disclosure

z_getpaymentdisclosure "txid" "js_index" "output_index" ("message")
z_validatepaymentdisclosure "paymentdisclosure"

Faucet

faucetaddress [pubkey]
faucetfund amount
faucetget
faucetinfo

Rogue Game

Gateways

Generating

generate numblocks
getgenerate
setgenerate generate ( genproclimit )

Heir

heiraddress func txid amount [destpubkey]

Lotto

lottoaddress [pubkey]

Mining

getblocksubsidy height
getblocktemplate ( "jsonrequestobject" )
getlocalsolps
getmininginfo
getnetworkhashps ( blocks height )
getnetworksolps ( blocks height )
prioritisetransaction
submitblock "hexdata" ( "jsonparametersobject" )

Network

Oracles

oraclesaddress [pubkey]
oraclescreate name description format
oraclesdata oracletxid hexstr
oraclesinfo oracletxid
oracleslist
oraclesregister oracletxid datafee
oraclessamples oracletxid batonutxo num
oraclessubscribe oracletxid publisher amount

Payments

paymentsaddress [pubkey]

Pegs

pegssaddress [pubkey]

Prices

pricesaddfunding fundingtxid bettoken amount
pricesaddress [pubkey]
pricesbet fundingtxid bettoken amount leverage
pricescreate bettoken oracletxid margin mode longtoken shorttoken maxleverage funding N [pubkeys]
pricesfinish fundingtxid bettoken bettxid
pricesinfo fundingtxid
priceslist
pricesstatus fundingtxid bettoken bettxid

Rawtransactions

createrawtransaction [{"txid":"id","vout":n},...] {"address":amount,...} ( locktime ) ( expiryheight )
decoderawtransaction "hexstring"
decodescript "hex"
fundrawtransaction "hexstring"
getrawtransaction "txid" ( verbose )
sendrawtransaction "hexstring" ( allowhighfees )
signrawtransaction "hexstring" ( [{"txid":"id","vout":n,"scriptPubKey":"hex","redeemScript":"hex"},...] ["privatekey1",...] sighashtype )

Rewards

rewardsaddfunding name fundingtxid amount
rewardsaddress [pubkey]
rewardscreatefunding name amount APR mindays maxdays mindeposit
rewardsinfo fundingtxid
rewardslist
rewardslock name fundingtxid amount
rewardsunlock name fundingtxid [txid]

Tokens

Triggers

triggersaddress [pubkey]

Util

Wallet

Verus blockchain specific Methods

Verus Identity

getidentity "name"
listidentities (includecansign) (includewatchonly)
recoveridentity "jsonidentity" (returntx)
registeridentity "jsonidregistration" feeoffer
registernamecommitment "name" "controladdress" ("referralidentity")
revokeidentity "nameorID" (returntx)
updateidentity "jsonidentity" (returntx)

Verus Multichain

Verus Wallet

convertpassphrase "walletpassphrase"
signfile "address or identity" "filepath/filename" "curentsig"
z_getmigrationstatus
z_setmigration enabled
z_viewtransaction "txid"

Name		Name	Last commit message	Last commit date
Latest commit History 338 Commits
LEGAL		LEGAL
btcec		btcec
chaincfg		chaincfg
examples		examples
kmdutil		kmdutil
wire		wire
.gitattributes		.gitattributes
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
TODO.md		TODO.md
blockchain.go		blockchain.go
cc_faucet.go		cc_faucet.go
cc_rogue.go		cc_rogue.go
cclib.go		cclib.go
common.go		common.go
control.go		control.go
dex.go		dex.go
doc.go		doc.go
go.mod		go.mod
go.sum		go.sum
main.go		main.go
mining.go		mining.go
network.go		network.go
rawtransactions.go		rawtransactions.go
util.go		util.go
verus_identity.go		verus_identity.go
verus_multichain.go		verus_multichain.go
wallet.go		wallet.go

License

satindergrewal/kmdgo

Folders and files

Latest commit

History

Repository files navigation