A Bitshares API consuming a websocket connection to an active full node or a RPC connection to your cli_wallet
.
Look for several examples in examples and tests folder. This is work in progress. To mitigate breaking changes, please use tagged branches. New tagged branches will be created for breaking changes. No additional cgo dependencies for transaction signing required. Use it at your own risk.
go get -u github.com/youthonline/bitshares
Install dev-dependencies with
make init
This API uses ffjson.
If you change types or operations you have to regenerate the required static MarshalJSON
and UnmarshalJSON
functions for the new/changed code.
make generate
If you encounter any errors, try:
make generate_new
to generate ffjson helpers from scratch.
To generate op samples for testing, go to gen package. Generated operation samples get injected automatically while running operation tests.
To test this stuff I use a combined docker based MainNet/TestNet wallet, you can find here. Operations testing uses generated real blockchain sample code by gen package. To test run:
make test_operations
make test_api
or a long running block (deserialize/serialize/compare) range test.
make test_blocks
wsFullApiUrl := "wss://bitshares.openledger.info/ws"
api := bitshares.NewWebsocketAPI(wsFullApiUrl)
if err := api.Connect(); err != nil {
log.Fatal(err)
}
api.OnError(func(err error) {
log.Fatal(err)
})
UserID := types.NewAccountID("1.2.253")
AssetBTS := types.NewAssetID("1.3.0")
res, api.GetAccountBalances(UserID, AssetBTS)
if err != nil {
log.Fatal(err)
}
log.Printf("balances: %v", res)
If you need wallet functions, use:
rpcApiUrl := "http://localhost:8095"
api := bitshares.NewWalletAPI(rpcApiUrl)
if err := api.Connect(); err != nil{
log.Fatal(err)
}
...
For a long application lifecycle, you can use an API instance with latency tester that connects to the most reliable node. Note: Because the tester takes time to unleash its magic, use the above-mentioned constructor for quick in and out.
wsFullApiUrl := "wss://bitshares.openledger.info/ws"
//wsFullApiUrl serves as "quick startup" fallback endpoint here,
//until the latency tester provides the first results.
api, err := bitshares.NewWithAutoEndpoint(wsFullApiUrl)
if err != nil {
log.Fatal(err)
}
if err := api.Connect(); err != nil {
log.Fatal(err)
}
api.OnError(func(err error) {
log.Fatal(err)
})
...
- OperationTypeTransfer OperationType
- OperationTypeLimitOrderCreate
- OperationTypeLimitOrderCancel
- OperationTypeCallOrderUpdate
- OperationTypeFillOrder (virtual)
- OperationTypeAccountCreate
- OperationTypeAccountUpdate
- OperationTypeAccountWhitelist
- OperationTypeAccountUpgrade
- OperationTypeAccountTransfer
- OperationTypeAssetCreate
- OperationTypeAssetUpdate
- OperationTypeAssetUpdateBitasset
- OperationTypeAssetUpdateFeedProducers
- OperationTypeAssetIssue
- OperationTypeAssetReserve
- OperationTypeAssetFundFeePool
- OperationTypeAssetSettle
- OperationTypeAssetGlobalSettle
- OperationTypeAssetPublishFeed
- OperationTypeWitnessCreate
- OperationTypeWitnessUpdate
- OperationTypeProposalCreate
- OperationTypeProposalUpdate
- OperationTypeProposalDelete
- OperationTypeWithdrawPermissionCreate
- OperationTypeWithdrawPermissionUpdate
- OperationTypeWithdrawPermissionClaim
- OperationTypeWithdrawPermissionDelete
- OperationTypeCommitteeMemberCreate
- OperationTypeCommitteeMemberUpdate
- OperationTypeCommitteeMemberUpdateGlobalParameters
- OperationTypeVestingBalanceCreate
- OperationTypeVestingBalanceWithdraw
- OperationTypeWorkerCreate
- OperationTypeCustom
- OperationTypeAssert
- OperationTypeBalanceClaim
- OperationTypeOverrideTransfer
- OperationTypeTransferToBlind
- OperationTypeBlindTransfer
- OperationTypeTransferFromBlind
- OperationTypeAssetSettleCancel
- OperationTypeAssetClaimFees
- OperationTypeFBADistribute
- OperationTypeBidColatteral
- OperationTypeExecuteBid
- add missing operations
- add convenience functions
Have fun and feel free to contribute needed operations and tests.