Merge pull request #15 from maestro-org/release-please--branches--mai…

…n--changes--next

release: 0.1.0-alpha.4

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.3"
+  ".": "0.1.0-alpha.4"
 }

CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.1.0-alpha.4 (2024-10-08)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/maestro-org/maestro-bitcoin-go-sdk/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+### Features
+
+* **api:** update via SDK Studio ([#11](https://github.com/maestro-org/maestro-bitcoin-go-sdk/issues/11)) ([11a3e7b](https://github.com/maestro-org/maestro-bitcoin-go-sdk/commit/11a3e7bd6a5512e946140cded8806a5b95ea8894))
+* **api:** update via SDK Studio ([#13](https://github.com/maestro-org/maestro-bitcoin-go-sdk/issues/13)) ([636420e](https://github.com/maestro-org/maestro-bitcoin-go-sdk/commit/636420ea7e5c57129bf846858df2bf1f72614634))
+
 ## 0.1.0-alpha.3 (2024-10-08)
 
 Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/maestro-org/maestro-bitcoin-go-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)

README.md

@@ -1,8 +1,8 @@
-# Maestro Bitcoin Go SDK
+# Maestro Bitcoin Go API Library
 
 <a href="https://pkg.go.dev/github.com/maestro-org/maestro-bitcoin-go-sdk"><img src="https://pkg.go.dev/badge/github.com/maestro-org/maestro-bitcoin-go-sdk.svg" alt="Go Reference"></a>
 
-The Maestro Bitcoin Go SDK provides convenient access to [the Maestro Bitcoin REST
+The Maestro Bitcoin Go library provides convenient access to [the Maestro REST
 API](https://docs.gomaestro.org/) from applications written in Go. The full API of this library can be found in [api.md](api.md).
 
 ## Installation
@@ -22,7 +22,7 @@ Or to pin the version:
 <!-- x-release-please-start-version -->
 
 ```sh
-go get -u 'github.com/maestro-org/[email protected].3'
+go get -u 'github.com/maestro-org/[email protected].4'
 ```
 
 <!-- x-release-please-end -->
@@ -49,13 +49,17 @@ import (
 func main() {
 	client := maestrobitcoingosdk.NewClient(
 		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("API_KEY")
-		option.WithEnvironmentMainnet(), // defaults to option.WithEnvironmentMainnet()
+		option.WithEnvironmentMainnet(), // or option.WithEnvironmentTestnet() | option.WithEnvironmentDefault(); defaults to option.WithEnvironmentTestnet()
+	)
+	paginatedUtxo, err := client.Addresses.Utxos.List(
+		context.TODO(),
+		"REPLACE_ME",
+		maestrobitcoingosdk.AddressUtxoListParams{},
 	)
-	timestampedBlock, err := client.Blocks.Latest.Get(context.TODO())
 	if err != nil {
 		panic(err.Error())
 	}
-	fmt.Printf("%+v\n", timestampedBlock.Data)
+	fmt.Printf("%+v\n", paginatedUtxo.Data)
 }
 
 ```
@@ -144,7 +148,7 @@ client := maestrobitcoingosdk.NewClient(
 	option.WithHeader("X-Some-Header", "custom_header_info"),
 )
 
-client.Blocks.Latest.Get(context.TODO(), ...,
+client.Addresses.Utxos.List(context.TODO(), ...,
 	// Override the header
 	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
 	// Add an undocumented field to the request body, using sjson syntax
@@ -173,14 +177,18 @@ When the API returns a non-success status code, we return an error with type
 To handle errors, we recommend that you use the `errors.As` pattern:
 
 ```go
-_, err := client.Blocks.Latest.Get(context.TODO())
+_, err := client.Addresses.Utxos.List(
+	context.TODO(),
+	"REPLACE_ME",
+	maestrobitcoingosdk.AddressUtxoListParams{},
+)
 if err != nil {
 	var apierr *maestrobitcoingosdk.Error
 	if errors.As(err, &apierr) {
 		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
 		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
 	}
-	panic(err.Error()) // GET "/blocks/latest": 400 Bad Request { ... }
+	panic(err.Error()) // GET "/addresses/{address}/utxos": 400 Bad Request { ... }
 }
 ```
 
@@ -198,8 +206,10 @@ To set a per-retry timeout, use `option.WithRequestTimeout()`.
 // This sets the timeout for the request, including all the retries.
 ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
 defer cancel()
-client.Blocks.Latest.Get(
+client.Addresses.Utxos.List(
 	ctx,
+	"REPLACE_ME",
+	maestrobitcoingosdk.AddressUtxoListParams{},
 	// This sets the per-retry timeout
 	option.WithRequestTimeout(20*time.Second),
 )
@@ -233,7 +243,12 @@ client := maestrobitcoingosdk.NewClient(
 )
 
 // Override per-request:
-client.Blocks.Latest.Get(context.TODO(), option.WithMaxRetries(5))
+client.Addresses.Utxos.List(
+	context.TODO(),
+	"REPLACE_ME",
+	maestrobitcoingosdk.AddressUtxoListParams{},
+	option.WithMaxRetries(5),
+)
 ```
 
 ### Making custom/undocumented requests

address.go

@@ -7,7 +7,7 @@ import (
 )
 
 // AddressService contains methods and other services that help with interacting
-// with the maestro API.
+// with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

addressbrc20.go

@@ -14,7 +14,7 @@ import (
 )
 
 // AddressBrc20Service contains methods and other services that help with
-// interacting with the maestro API.
+// interacting with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

addressbrc20_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAddressBrc20List(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

addressrune.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AddressRuneService contains methods and other services that help with
-// interacting with the maestro API.
+// interacting with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

addressrune_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAddressRuneGetWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL
@@ -47,6 +48,7 @@ func TestAddressRuneGetWithOptionalParams(t *testing.T) {
 }
 
 func TestAddressRuneList(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

addresstx.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AddressTxService contains methods and other services that help with interacting
-// with the maestro API.
+// with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

addresstx_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAddressTxListWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

addressutxo.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AddressUtxoService contains methods and other services that help with
-// interacting with the maestro API.
+// interacting with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

addressutxo_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAddressUtxoListWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

asset.go

@@ -7,7 +7,7 @@ import (
 )
 
 // AssetService contains methods and other services that help with interacting with
-// the maestro API.
+// the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

assetbrc20.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AssetBrc20Service contains methods and other services that help with interacting
-// with the maestro API.
+// with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

assetbrc20_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAssetBrc20Get(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL
@@ -36,6 +37,7 @@ func TestAssetBrc20Get(t *testing.T) {
 }
 
 func TestAssetBrc20ListWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

assetbrc20holder.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AssetBrc20HolderService contains methods and other services that help with
-// interacting with the maestro API.
+// interacting with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

assetbrc20holder_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAssetBrc20HolderListWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

assetrune.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AssetRuneService contains methods and other services that help with interacting
-// with the maestro API.
+// with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

assetrune_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAssetRuneGet(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL
@@ -36,6 +37,7 @@ func TestAssetRuneGet(t *testing.T) {
 }
 
 func TestAssetRuneListWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

assetruneholder.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AssetRuneHolderService contains methods and other services that help with
-// interacting with the maestro API.
+// interacting with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

assetruneholder_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAssetRuneHolderListWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

assetruneutxo.go

@@ -17,7 +17,7 @@ import (
 )
 
 // AssetRuneUtxoService contains methods and other services that help with
-// interacting with the maestro API.
+// interacting with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

assetruneutxo_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestAssetRuneUtxoListWithOptionalParams(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

block.go

@@ -15,7 +15,7 @@ import (
 )
 
 // BlockService contains methods and other services that help with interacting with
-// the maestro API.
+// the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

block_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestBlockGet(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

blocklatest.go

@@ -11,7 +11,7 @@ import (
 )
 
 // BlockLatestService contains methods and other services that help with
-// interacting with the maestro API.
+// interacting with the Maestro API.
 //
 // Note, unlike clients, this service does not read variables from the environment
 // automatically. You should not instantiate this service directly, and instead use

blocklatest_test.go

@@ -14,6 +14,7 @@ import (
 )
 
 func TestBlockLatestGet(t *testing.T) {
+	t.Skip("skipped: tests are disabled for the time being")
 	baseURL := "http://localhost:4010"
 	if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
 		baseURL = envURL

client.go

@@ -12,7 +12,7 @@ import (
 )
 
 // Client creates a struct with services and top level methods that help with
-// interacting with the maestro API. You should not instantiate this client
+// interacting with the Maestro API. You should not instantiate this client
 // directly, and instead use the [NewClient] method instead.
 type Client struct {
 	Options         []option.RequestOption
@@ -30,7 +30,7 @@ type Client struct {
 // default arguments, and all option will be passed down to the services and
 // requests that this client makes.
 func NewClient(opts ...option.RequestOption) (r *Client) {
-	defaults := []option.RequestOption{option.WithEnvironmentMainnet()}
+	defaults := []option.RequestOption{option.WithEnvironmentTestnet()}
 	if o, ok := os.LookupEnv("API_KEY"); ok {
 		defaults = append(defaults, option.WithAPIKey(o))
 	}