blockaidclientgo

package module
v0.34.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 22, 2024 License: Apache-2.0 Imports: 13 Imported by: 0

README

Blockaid Go API Library

Go Reference

The Blockaid Go library provides convenient access to the Blockaid REST API from applications written in Go. The full API of this library can be found in api.md.

It is generated with Stainless.

Installation

import (
	"github.com/blockaid-official/blockaid-client-go" // imported as blockaidclientgo
)

Or to pin the version:

go get -u 'github.com/blockaid-official/blockaid-client-go@v0.34.0'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/blockaid-official/blockaid-client-go"
	"github.com/blockaid-official/blockaid-client-go/option"
)

func main() {
	client := blockaidclientgo.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("BLOCKAID_CLIENT_API_KEY")
		option.WithEnvironmentClient(),  // defaults to option.WithEnvironmentProduction()
	)
	transactionScanResponse, err := client.Evm.JsonRpc.Scan(context.TODO(), blockaidclientgo.EvmJsonRpcScanParams{
		Chain: blockaidclientgo.F(blockaidclientgo.TransactionScanSupportedChainArbitrum),
		Data: blockaidclientgo.F(blockaidclientgo.EvmJsonRpcScanParamsData{
			Method: blockaidclientgo.F("eth_signTypedData_v4"),
			Params: blockaidclientgo.F([]interface{}{"0x49c73c9d361c04769a452E85D343b41aC38e0EE4", "{\"domain\":{\"chainId\":1,\"name\":\"Aave interest bearing WETH\",\"version\":\"1\",\"verifyingContract\":\"0x030ba81f1c18d280636f32af80b9aad02cf0854e\"},\"message\":{\"owner\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\",\"spender\":\"0xa74cbd5b80f73b5950768c8dc467f1c6307c00fd\",\"value\":\"115792089237316195423570985008687907853269984665640564039457584007913129639935\",\"nonce\":\"0\",\"deadline\":\"1988064000\",\"holder\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\"},\"primaryType\":\"Permit\",\"types\":{\"EIP712Domain\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"},{\"name\":\"chainId\",\"type\":\"uint256\"},{\"name\":\"verifyingContract\",\"type\":\"address\"}],\"Permit\":[{\"name\":\"owner\",\"type\":\"address\"},{\"name\":\"spender\",\"type\":\"address\"},{\"name\":\"value\",\"type\":\"uint256\"},{\"name\":\"nonce\",\"type\":\"uint256\"},{\"name\":\"deadline\",\"type\":\"uint256\"}]}}"}),
		}),
		Metadata: blockaidclientgo.F(blockaidclientgo.MetadataParam{
			Domain: blockaidclientgo.F("https://boredapeyartclub.com"),
		}),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", transactionScanResponse.Validation)
}

Request fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: blockaidclientgo.F("hello"),

	// Explicitly send `"description": null`
	Description: blockaidclientgo.Null[string](),

	Point: blockaidclientgo.F(blockaidclientgo.Point{
		X: blockaidclientgo.Int(0),
		Y: blockaidclientgo.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: blockaidclientgo.Raw[int64](0.01), // sends a float
	}),
}
Response objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the response JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := blockaidclientgo.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Evm.JsonRpc.Scan(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
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *blockaidclientgo.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Evm.JsonRpc.Scan(context.TODO(), blockaidclientgo.EvmJsonRpcScanParams{
	Chain: blockaidclientgo.F(blockaidclientgo.TransactionScanSupportedChainArbitrum),
	Data: blockaidclientgo.F(blockaidclientgo.EvmJsonRpcScanParamsData{
		Method: blockaidclientgo.F("eth_signTypedData_v4"),
		Params: blockaidclientgo.F([]interface{}{"0x49c73c9d361c04769a452E85D343b41aC38e0EE4", "{\"domain\":{\"chainId\":1,\"name\":\"Aave interest bearing WETH\",\"version\":\"1\",\"verifyingContract\":\"0x030ba81f1c18d280636f32af80b9aad02cf0854e\"},\"message\":{\"owner\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\",\"spender\":\"0xa74cbd5b80f73b5950768c8dc467f1c6307c00fd\",\"value\":\"115792089237316195423570985008687907853269984665640564039457584007913129639935\",\"nonce\":\"0\",\"deadline\":\"1988064000\",\"holder\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\"},\"primaryType\":\"Permit\",\"types\":{\"EIP712Domain\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"},{\"name\":\"chainId\",\"type\":\"uint256\"},{\"name\":\"verifyingContract\",\"type\":\"address\"}],\"Permit\":[{\"name\":\"owner\",\"type\":\"address\"},{\"name\":\"spender\",\"type\":\"address\"},{\"name\":\"value\",\"type\":\"uint256\"},{\"name\":\"nonce\",\"type\":\"uint256\"},{\"name\":\"deadline\",\"type\":\"uint256\"}]}}"}),
	}),
	Metadata: blockaidclientgo.F(blockaidclientgo.MetadataParam{
		Domain: blockaidclientgo.F("https://boredapeyartclub.com"),
	}),
})
if err != nil {
	var apierr *blockaidclientgo.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 "/v0/evm/json-rpc/scan": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. 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.Evm.JsonRpc.Scan(
	ctx,
	blockaidclientgo.EvmJsonRpcScanParams{
		Chain: blockaidclientgo.F(blockaidclientgo.TransactionScanSupportedChainArbitrum),
		Data: blockaidclientgo.F(blockaidclientgo.EvmJsonRpcScanParamsData{
			Method: blockaidclientgo.F("eth_signTypedData_v4"),
			Params: blockaidclientgo.F([]interface{}{"0x49c73c9d361c04769a452E85D343b41aC38e0EE4", "{\"domain\":{\"chainId\":1,\"name\":\"Aave interest bearing WETH\",\"version\":\"1\",\"verifyingContract\":\"0x030ba81f1c18d280636f32af80b9aad02cf0854e\"},\"message\":{\"owner\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\",\"spender\":\"0xa74cbd5b80f73b5950768c8dc467f1c6307c00fd\",\"value\":\"115792089237316195423570985008687907853269984665640564039457584007913129639935\",\"nonce\":\"0\",\"deadline\":\"1988064000\",\"holder\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\"},\"primaryType\":\"Permit\",\"types\":{\"EIP712Domain\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"},{\"name\":\"chainId\",\"type\":\"uint256\"},{\"name\":\"verifyingContract\",\"type\":\"address\"}],\"Permit\":[{\"name\":\"owner\",\"type\":\"address\"},{\"name\":\"spender\",\"type\":\"address\"},{\"name\":\"value\",\"type\":\"uint256\"},{\"name\":\"nonce\",\"type\":\"uint256\"},{\"name\":\"deadline\",\"type\":\"uint256\"}]}}"}),
		}),
		Metadata: blockaidclientgo.F(blockaidclientgo.MetadataParam{
			Domain: blockaidclientgo.F("https://boredapeyartclub.com"),
		}),
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as param.Field[io.Reader]. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper blockaidclientgo.FileParam(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := blockaidclientgo.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Evm.JsonRpc.Scan(
	context.TODO(),
	blockaidclientgo.EvmJsonRpcScanParams{
		Chain: blockaidclientgo.F(blockaidclientgo.TransactionScanSupportedChainArbitrum),
		Data: blockaidclientgo.F(blockaidclientgo.EvmJsonRpcScanParamsData{
			Method: blockaidclientgo.F("eth_signTypedData_v4"),
			Params: blockaidclientgo.F([]interface{}{"0x49c73c9d361c04769a452E85D343b41aC38e0EE4", "{\"domain\":{\"chainId\":1,\"name\":\"Aave interest bearing WETH\",\"version\":\"1\",\"verifyingContract\":\"0x030ba81f1c18d280636f32af80b9aad02cf0854e\"},\"message\":{\"owner\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\",\"spender\":\"0xa74cbd5b80f73b5950768c8dc467f1c6307c00fd\",\"value\":\"115792089237316195423570985008687907853269984665640564039457584007913129639935\",\"nonce\":\"0\",\"deadline\":\"1988064000\",\"holder\":\"0x49c73c9d361c04769a452E85D343b41aC38e0EE4\"},\"primaryType\":\"Permit\",\"types\":{\"EIP712Domain\":[{\"name\":\"name\",\"type\":\"string\"},{\"name\":\"version\",\"type\":\"string\"},{\"name\":\"chainId\",\"type\":\"uint256\"},{\"name\":\"verifyingContract\",\"type\":\"address\"}],\"Permit\":[{\"name\":\"owner\",\"type\":\"address\"},{\"name\":\"spender\",\"type\":\"address\"},{\"name\":\"value\",\"type\":\"uint256\"},{\"name\":\"nonce\",\"type\":\"uint256\"},{\"name\":\"deadline\",\"type\":\"uint256\"}]}}"}),
		}),
		Metadata: blockaidclientgo.F(blockaidclientgo.MetadataParam{
			Domain: blockaidclientgo.F("https://boredapeyartclub.com"),
		}),
	},
	option.WithMaxRetries(5),
)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]interface{}

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   blockaidclientgo.F("id_xxxx"),
    Data: blockaidclientgo.F(FooNewParamsData{
        FirstName: blockaidclientgo.F("John"),
    }),
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := blockaidclientgo.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func F

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func FileParam

func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

FileParam is a param field helper which helps files with a mime content-type.

func Float

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null

func Null[T any]() param.Field[T]

Null is a param field helper which explicitly sends null to the API.

func Raw

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type APIErrorDetails added in v0.22.1

type APIErrorDetails struct {
	// Advanced message of the error
	Message string              `json:"message,required"`
	Type    string              `json:"type"`
	JSON    apiErrorDetailsJSON `json:"-"`
}

func (*APIErrorDetails) UnmarshalJSON added in v0.22.1

func (r *APIErrorDetails) UnmarshalJSON(data []byte) (err error)

type AccountSummarySchema added in v0.12.0

type AccountSummarySchema struct {
	// Total USD diff for the requested account address
	TotalUsdDiff TotalUsdDiffSchema `json:"total_usd_diff,required"`
	// Assets diff of the requested account address
	AccountAssetsDiff []AccountSummarySchemaAccountAssetsDiff `json:"account_assets_diff"`
	// Delegated assets of the requested account address
	AccountDelegations []DelegatedAssetDetailsSchema `json:"account_delegations"`
	// Account ownerships diff of the requested account address
	AccountOwnershipsDiff []AccountSummarySchemaAccountOwnershipsDiff `json:"account_ownerships_diff"`
	JSON                  accountSummarySchemaJSON                    `json:"-"`
}

func (*AccountSummarySchema) UnmarshalJSON added in v0.12.0

func (r *AccountSummarySchema) UnmarshalJSON(data []byte) (err error)

type AccountSummarySchemaAccountAssetsDiff added in v0.12.0

type AccountSummarySchemaAccountAssetsDiff struct {
	// This field can have the runtime type of [NativeDetailsSchema],
	// [SplFungibleTokenDetailsSchema], [SplNonFungibleTokenDetailsSchema],
	// [CnftDetailsSchema].
	Asset interface{} `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// Incoming transfers of the asset
	In   AssetTransferDetailsSchema                `json:"in,nullable"`
	Out  AssetTransferDetailsSchema                `json:"out,nullable"`
	JSON accountSummarySchemaAccountAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (AccountSummarySchemaAccountAssetsDiff) AsUnion added in v0.12.0

AsUnion returns a AccountSummarySchemaAccountAssetsDiffUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are NativeDiffSchema, SplFungibleTokenDiffSchema, SplNonFungibleTokenDiffSchema, CnftDiffSchema.

func (*AccountSummarySchemaAccountAssetsDiff) UnmarshalJSON added in v0.12.0

func (r *AccountSummarySchemaAccountAssetsDiff) UnmarshalJSON(data []byte) (err error)

type AccountSummarySchemaAccountAssetsDiffUnion added in v0.12.0

type AccountSummarySchemaAccountAssetsDiffUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by NativeDiffSchema, SplFungibleTokenDiffSchema, SplNonFungibleTokenDiffSchema or CnftDiffSchema.

type AccountSummarySchemaAccountOwnershipsDiff added in v0.12.0

type AccountSummarySchemaAccountOwnershipsDiff struct {
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// The owner post the transaction
	PostOwner string `json:"post_owner,required"`
	// This field can have the runtime type of [NativeDetailsSchema],
	// [SplTokenOwnershipDiffSchemaAsset], [StakedAssetDetailsSchema].
	Asset interface{} `json:"asset"`
	// Incoming transfers of the asset
	In AssetTransferDetailsSchema `json:"in_,nullable"`
	// Details of the moved value
	Out AssetTransferDetailsSchema `json:"out,nullable"`
	// The owner prior to the transaction
	PreOwner string                                        `json:"pre_owner,nullable"`
	JSON     accountSummarySchemaAccountOwnershipsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (AccountSummarySchemaAccountOwnershipsDiff) AsUnion added in v0.12.0

AsUnion returns a AccountSummarySchemaAccountOwnershipsDiffUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are NativeSolOwnershipDiffSchema, SplTokenOwnershipDiffSchema, StakedSolWithdrawAuthorityDiffSchema.

func (*AccountSummarySchemaAccountOwnershipsDiff) UnmarshalJSON added in v0.12.0

func (r *AccountSummarySchemaAccountOwnershipsDiff) UnmarshalJSON(data []byte) (err error)

type AccountSummarySchemaAccountOwnershipsDiffUnion added in v0.12.0

type AccountSummarySchemaAccountOwnershipsDiffUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by NativeSolOwnershipDiffSchema, SplTokenOwnershipDiffSchema or StakedSolWithdrawAuthorityDiffSchema.

type AddressScanRequestSchemaMetadataParam added in v0.12.0

type AddressScanRequestSchemaMetadataParam struct {
	// URL of the dApp related to the address
	URL param.Field[string] `json:"url,required"`
}

func (AddressScanRequestSchemaMetadataParam) MarshalJSON added in v0.12.0

func (r AddressScanRequestSchemaMetadataParam) MarshalJSON() (data []byte, err error)

type AddressScanRequestSchemaParam added in v0.12.0

type AddressScanRequestSchemaParam struct {
	// Encoded public key
	Address  param.Field[string]                                `json:"address,required"`
	Metadata param.Field[AddressScanRequestSchemaMetadataParam] `json:"metadata,required"`
	// Chain to scan the transaction on
	Chain param.Field[string] `json:"chain"`
}

func (AddressScanRequestSchemaParam) MarshalJSON added in v0.12.0

func (r AddressScanRequestSchemaParam) MarshalJSON() (data []byte, err error)

type AddressScanResponseSchema added in v0.12.0

type AddressScanResponseSchema struct {
	// Features about the result
	Features []AddressScanResponseSchemaFeature `json:"features,required"`
	// An enumeration.
	ResultType AddressScanResponseSchemaResultType `json:"result_type,required"`
	JSON       addressScanResponseSchemaJSON       `json:"-"`
}

func (*AddressScanResponseSchema) UnmarshalJSON added in v0.12.0

func (r *AddressScanResponseSchema) UnmarshalJSON(data []byte) (err error)

type AddressScanResponseSchemaFeature added in v0.12.0

type AddressScanResponseSchemaFeature struct {
	// Description of the feature
	Description string `json:"description,required"`
	// ID of the feature
	FeatureID string `json:"feature_id,required"`
	// An enumeration.
	Type AddressScanResponseSchemaFeaturesType `json:"type,required"`
	JSON addressScanResponseSchemaFeatureJSON  `json:"-"`
}

func (*AddressScanResponseSchemaFeature) UnmarshalJSON added in v0.12.0

func (r *AddressScanResponseSchemaFeature) UnmarshalJSON(data []byte) (err error)

type AddressScanResponseSchemaFeaturesType added in v0.12.0

type AddressScanResponseSchemaFeaturesType string

An enumeration.

const (
	AddressScanResponseSchemaFeaturesTypeMalicious AddressScanResponseSchemaFeaturesType = "Malicious"
	AddressScanResponseSchemaFeaturesTypeWarning   AddressScanResponseSchemaFeaturesType = "Warning"
	AddressScanResponseSchemaFeaturesTypeBenign    AddressScanResponseSchemaFeaturesType = "Benign"
	AddressScanResponseSchemaFeaturesTypeInfo      AddressScanResponseSchemaFeaturesType = "Info"
)

func (AddressScanResponseSchemaFeaturesType) IsKnown added in v0.12.0

type AddressScanResponseSchemaResultType added in v0.12.0

type AddressScanResponseSchemaResultType string

An enumeration.

const (
	AddressScanResponseSchemaResultTypeMalicious AddressScanResponseSchemaResultType = "Malicious"
	AddressScanResponseSchemaResultTypeWarning   AddressScanResponseSchemaResultType = "Warning"
	AddressScanResponseSchemaResultTypeBenign    AddressScanResponseSchemaResultType = "Benign"
)

func (AddressScanResponseSchemaResultType) IsKnown added in v0.12.0

type AssetTransferDetailsSchema added in v0.12.0

type AssetTransferDetailsSchema struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// Value of the transfer
	Value float64 `json:"value,required"`
	// Summarized description of the transfer
	Summary string `json:"summary,nullable"`
	// USD price of the asset
	UsdPrice float64                        `json:"usd_price,nullable"`
	JSON     assetTransferDetailsSchemaJSON `json:"-"`
}

func (*AssetTransferDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *AssetTransferDetailsSchema) UnmarshalJSON(data []byte) (err error)

type BitcoinService added in v0.20.0

type BitcoinService struct {
	Options        []option.RequestOption
	TransactionRaw *BitcoinTransactionRawService
}

BitcoinService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBitcoinService method instead.

func NewBitcoinService added in v0.20.0

func NewBitcoinService(opts ...option.RequestOption) (r *BitcoinService)

NewBitcoinService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type BitcoinTransactionRawReportParams added in v0.34.0

type BitcoinTransactionRawReportParams struct {
	Details param.Field[string]                                       `json:"details,required"`
	Event   param.Field[BitcoinTransactionRawReportParamsEvent]       `json:"event,required"`
	Report  param.Field[BitcoinTransactionRawReportParamsReportUnion] `json:"report,required"`
}

func (BitcoinTransactionRawReportParams) MarshalJSON added in v0.34.0

func (r BitcoinTransactionRawReportParams) MarshalJSON() (data []byte, err error)

type BitcoinTransactionRawReportParamsEvent added in v0.34.0

type BitcoinTransactionRawReportParamsEvent string
const (
	BitcoinTransactionRawReportParamsEventShouldBeMalicious     BitcoinTransactionRawReportParamsEvent = "should_be_malicious"
	BitcoinTransactionRawReportParamsEventShouldBeBenign        BitcoinTransactionRawReportParamsEvent = "should_be_benign"
	BitcoinTransactionRawReportParamsEventWrongSimulationResult BitcoinTransactionRawReportParamsEvent = "wrong_simulation_result"
)

func (BitcoinTransactionRawReportParamsEvent) IsKnown added in v0.34.0

type BitcoinTransactionRawReportParamsReport added in v0.34.0

type BitcoinTransactionRawReportParamsReport struct {
	ID     param.Field[string]                                      `json:"id"`
	Params param.Field[BitcoinTransactionScanRequestParam]          `json:"params"`
	Type   param.Field[BitcoinTransactionRawReportParamsReportType] `json:"type"`
}

func (BitcoinTransactionRawReportParamsReport) MarshalJSON added in v0.34.0

func (r BitcoinTransactionRawReportParamsReport) MarshalJSON() (data []byte, err error)

type BitcoinTransactionRawReportParamsReportBitcoinAppealRequestID added in v0.34.0

type BitcoinTransactionRawReportParamsReportBitcoinAppealRequestID struct {
	ID   param.Field[string]                                                            `json:"id,required"`
	Type param.Field[BitcoinTransactionRawReportParamsReportBitcoinAppealRequestIDType] `json:"type"`
}

func (BitcoinTransactionRawReportParamsReportBitcoinAppealRequestID) MarshalJSON added in v0.34.0

type BitcoinTransactionRawReportParamsReportBitcoinAppealRequestIDType added in v0.34.0

type BitcoinTransactionRawReportParamsReportBitcoinAppealRequestIDType string
const (
	BitcoinTransactionRawReportParamsReportBitcoinAppealRequestIDTypeRequestID BitcoinTransactionRawReportParamsReportBitcoinAppealRequestIDType = "request_id"
)

func (BitcoinTransactionRawReportParamsReportBitcoinAppealRequestIDType) IsKnown added in v0.34.0

type BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReport added in v0.34.0

type BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReport struct {
	Params param.Field[BitcoinTransactionScanRequestParam]                                            `json:"params,required"`
	Type   param.Field[BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReportType] `json:"type"`
}

func (BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReport) MarshalJSON added in v0.34.0

type BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReportType added in v0.34.0

type BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReportType string
const (
	BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReportTypeParams BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReportType = "params"
)

func (BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReportType) IsKnown added in v0.34.0

type BitcoinTransactionRawReportParamsReportType added in v0.34.0

type BitcoinTransactionRawReportParamsReportType string
const (
	BitcoinTransactionRawReportParamsReportTypeRequestID BitcoinTransactionRawReportParamsReportType = "request_id"
	BitcoinTransactionRawReportParamsReportTypeParams    BitcoinTransactionRawReportParamsReportType = "params"
)

func (BitcoinTransactionRawReportParamsReportType) IsKnown added in v0.34.0

type BitcoinTransactionRawReportParamsReportUnion added in v0.34.0

type BitcoinTransactionRawReportParamsReportUnion interface {
	// contains filtered or unexported methods
}

Satisfied by BitcoinTransactionRawReportParamsReportBitcoinAppealRequestID, BitcoinTransactionRawReportParamsReportBitcoinAppealTransactionDataReport, BitcoinTransactionRawReportParamsReport.

type BitcoinTransactionRawScanParams added in v0.34.0

type BitcoinTransactionRawScanParams struct {
	BitcoinTransactionScanRequest BitcoinTransactionScanRequestParam `json:"BitcoinTransactionScanRequest,required"`
}

func (BitcoinTransactionRawScanParams) MarshalJSON added in v0.34.0

func (r BitcoinTransactionRawScanParams) MarshalJSON() (data []byte, err error)

type BitcoinTransactionRawService added in v0.34.0

type BitcoinTransactionRawService struct {
	Options []option.RequestOption
}

BitcoinTransactionRawService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewBitcoinTransactionRawService method instead.

func NewBitcoinTransactionRawService added in v0.34.0

func NewBitcoinTransactionRawService(opts ...option.RequestOption) (r *BitcoinTransactionRawService)

NewBitcoinTransactionRawService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*BitcoinTransactionRawService) Report added in v0.34.0

Report Transaction

func (*BitcoinTransactionRawService) Scan added in v0.34.0

Scan Transaction

type BitcoinTransactionScanRequestChain added in v0.29.0

type BitcoinTransactionScanRequestChain string
const (
	BitcoinTransactionScanRequestChainBitcoin BitcoinTransactionScanRequestChain = "bitcoin"
)

func (BitcoinTransactionScanRequestChain) IsKnown added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataParam added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataParam struct {
	// Metadata for in-app requests
	Type param.Field[BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataType] `json:"type"`
}

func (BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataParam) MarshalJSON added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataType added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataType string

Metadata for in-app requests

const (
	BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataTypeInApp BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataType = "in_app"
)

func (BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataType) IsKnown added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataParam added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataParam struct {
	// Metadata for wallet requests
	Type param.Field[BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataType] `json:"type,required"`
	// URL of the dApp originating the transaction
	URL param.Field[string] `json:"url,required"`
}

func (BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataParam) MarshalJSON added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataType added in v0.29.0

type BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataType string

Metadata for wallet requests

const (
	BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataTypeWallet BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataType = "wallet"
)

func (BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataType) IsKnown added in v0.29.0

type BitcoinTransactionScanRequestMetadataParam added in v0.29.0

type BitcoinTransactionScanRequestMetadataParam struct {
	// Metadata for wallet requests
	Type param.Field[BitcoinTransactionScanRequestMetadataType] `json:"type"`
	// URL of the dApp originating the transaction
	URL param.Field[string] `json:"url"`
}

Metadata

func (BitcoinTransactionScanRequestMetadataParam) MarshalJSON added in v0.29.0

func (r BitcoinTransactionScanRequestMetadataParam) MarshalJSON() (data []byte, err error)

type BitcoinTransactionScanRequestMetadataType added in v0.29.0

type BitcoinTransactionScanRequestMetadataType string

Metadata for wallet requests

const (
	BitcoinTransactionScanRequestMetadataTypeWallet BitcoinTransactionScanRequestMetadataType = "wallet"
	BitcoinTransactionScanRequestMetadataTypeInApp  BitcoinTransactionScanRequestMetadataType = "in_app"
)

func (BitcoinTransactionScanRequestMetadataType) IsKnown added in v0.29.0

type BitcoinTransactionScanRequestMetadataUnionParam added in v0.29.0

type BitcoinTransactionScanRequestMetadataUnionParam interface {
	// contains filtered or unexported methods
}

Metadata

Satisfied by BitcoinTransactionScanRequestMetadataBitcoinWalletRequestMetadataParam, BitcoinTransactionScanRequestMetadataBitcoinInAppRequestMetadataParam, BitcoinTransactionScanRequestMetadataParam.

type BitcoinTransactionScanRequestOption added in v0.29.0

type BitcoinTransactionScanRequestOption string
const (
	BitcoinTransactionScanRequestOptionValidation BitcoinTransactionScanRequestOption = "validation"
	BitcoinTransactionScanRequestOptionSimulation BitcoinTransactionScanRequestOption = "simulation"
)

func (BitcoinTransactionScanRequestOption) IsKnown added in v0.29.0

type BitcoinTransactionScanRequestParam added in v0.29.0

type BitcoinTransactionScanRequestParam struct {
	AccountAddress param.Field[string]                             `json:"account_address,required"`
	Chain          param.Field[BitcoinTransactionScanRequestChain] `json:"chain,required"`
	// Metadata
	Metadata    param.Field[BitcoinTransactionScanRequestMetadataUnionParam] `json:"metadata,required"`
	Transaction param.Field[string]                                          `json:"transaction,required"`
	// List of options to include in the response
	//
	// - `Options.validation`: Include Options.validation output in the response
	//
	// - `Options.simulation`: Include Options.simulation output in the response
	Options param.Field[[]BitcoinTransactionScanRequestOption] `json:"options"`
}

func (BitcoinTransactionScanRequestParam) MarshalJSON added in v0.29.0

func (r BitcoinTransactionScanRequestParam) MarshalJSON() (data []byte, err error)

type BitcoinTransactionScanResponse added in v0.20.0

type BitcoinTransactionScanResponse struct {
	// Simulation result; Only present if simulation option is included in the request
	Simulation BitcoinTransactionScanResponseSimulation `json:"simulation,nullable"`
	// Validation result; Only present if validation option is included in the request
	Validation BitcoinTransactionScanResponseValidation `json:"validation,nullable"`
	JSON       bitcoinTransactionScanResponseJSON       `json:"-"`
}

func (*BitcoinTransactionScanResponse) UnmarshalJSON added in v0.20.0

func (r *BitcoinTransactionScanResponse) UnmarshalJSON(data []byte) (err error)

type BitcoinTransactionScanResponseSimulation added in v0.20.0

type BitcoinTransactionScanResponseSimulation struct {
	Status BitcoinTransactionScanResponseSimulationStatus `json:"status,required"`
	// This field can have the runtime type of
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummary].
	AccountSummary interface{} `json:"account_summary"`
	// This field can have the runtime type of
	// [[]BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAddressDetail].
	AddressDetails interface{} `json:"address_details"`
	// This field can have the runtime type of
	// [map[string][]BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiff].
	AssetsDiffs interface{} `json:"assets_diffs"`
	// Error message
	Error string                                       `json:"error"`
	JSON  bitcoinTransactionScanResponseSimulationJSON `json:"-"`
	// contains filtered or unexported fields
}

Simulation result; Only present if simulation option is included in the request

func (BitcoinTransactionScanResponseSimulation) AsUnion added in v0.20.0

AsUnion returns a BitcoinTransactionScanResponseSimulationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BitcoinTransactionScanResponseSimulationBitcoinSimulationResult, BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchema.

func (*BitcoinTransactionScanResponseSimulation) UnmarshalJSON added in v0.20.0

func (r *BitcoinTransactionScanResponseSimulation) UnmarshalJSON(data []byte) (err error)

type BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchema added in v0.20.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchema struct {
	// Error message
	Error  string                                                                     `json:"error,required"`
	Status BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchemaStatus `json:"status,required"`
	JSON   bitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchemaJSON   `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchema) UnmarshalJSON added in v0.20.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchemaStatus added in v0.20.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchemaStatus string
const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchemaStatusError BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchemaStatus = "Error"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchemaStatus) IsKnown added in v0.20.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResult added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResult struct {
	// Summary of the actions and asset transfers that were made by the requested
	// account address
	AccountSummary BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummary `json:"account_summary,required"`
	Status         BitcoinTransactionScanResponseSimulationBitcoinSimulationResultStatus         `json:"status,required"`
	// Details of addresses involved in the transaction
	AddressDetails []BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAddressDetail `json:"address_details"`
	// Mapping between the address of an account to the assets diff during the
	// transaction
	AssetsDiffs map[string][]BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiff `json:"assets_diffs"`
	JSON        bitcoinTransactionScanResponseSimulationBitcoinSimulationResultJSON                    `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResult) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummary added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummary struct {
	// Total USD diff for the requested account address
	TotalUsdDiff BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryTotalUsdDiff `json:"total_usd_diff,required"`
	// Assets diffs of the requested account address
	AccountAssetsDiffs []BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiff `json:"account_assets_diffs"`
	JSON               bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryJSON                `json:"-"`
}

Summary of the actions and asset transfers that were made by the requested account address

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummary) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiff added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiff struct {
	// This field can have the runtime type of
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAsset],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAsset],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAsset].
	Asset interface{} `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// This field can have the runtime type of
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffIn],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffIn],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffIn].
	In interface{} `json:"in"`
	// This field can have the runtime type of
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffOut],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffOut],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffOut].
	Out  interface{}                                                                                        `json:"out"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiff) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiff added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiff struct {
	Asset BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAsset `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffIn `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffOut  `json:"out,nullable"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiff) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAsset added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAsset struct {
	// The Inscription ID
	ID string `json:"id,required"`
	// Inscription's display name
	Name string `json:"name,required"`
	// The Inscription sat
	Sat int64 `json:"sat,required"`
	// URL of the asset's logo
	LogoURL string `json:"logo_url,nullable"`
	// Type of the asset (`INSCRIPTION`)
	Type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAssetType `json:"type"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAssetJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAsset) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAssetType added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAssetType string

Type of the asset (`INSCRIPTION`)

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAssetTypeInscription BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAssetType = "INSCRIPTION"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffAssetType) IsKnown added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffIn added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffIn struct {
	// Inscription ID of the transfer
	InscriptionID string `json:"inscription_id,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Summarized description of the transfer
	Summary string                                                                                                                           `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffInJSON `json:"-"`
}

Details of the incoming transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffIn) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffOut added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffOut struct {
	// Inscription ID of the transfer
	InscriptionID string `json:"inscription_id,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Summarized description of the transfer
	Summary string                                                                                                                            `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffOutJSON `json:"-"`
}

Details of the outgoing transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinInscriptionAssetDiffOut) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiff added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiff struct {
	Asset BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAsset `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffIn `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffOut  `json:"out,nullable"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiff) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAsset added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAsset struct {
	// URL of the asset's logo
	LogoURL string `json:"logo_url,required,nullable"`
	// Decimals of the asset
	Decimals BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetDecimals `json:"decimals"`
	// Name of the asset
	Name BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetName `json:"name"`
	// Symbol of the asset
	Symbol BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetSymbol `json:"symbol"`
	// Type of the asset (`NATIVE`)
	Type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetType `json:"type"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAsset) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetDecimals added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetDecimals int64

Decimals of the asset

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetDecimals8 BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetDecimals = 8
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetDecimals) IsKnown added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetName added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetName string

Name of the asset

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetNameBitcoin BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetName = "Bitcoin"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetName) IsKnown added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetSymbol added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetSymbol string

Symbol of the asset

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetSymbolBtc BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetSymbol = "BTC"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetSymbol) IsKnown added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetType added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetType string

Type of the asset (`NATIVE`)

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetTypeNative BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetType = "NATIVE"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffAssetType) IsKnown added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffIn added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffIn struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                                      `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffInJSON `json:"-"`
}

Details of the incoming transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffIn) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffOut added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffOut struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                                       `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffOutJSON `json:"-"`
}

Details of the outgoing transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinNativeAssetDiffOut) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiff added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiff struct {
	Asset BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAsset `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffIn `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffOut  `json:"out,nullable"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiff) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAsset added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAsset struct {
	// The Rune ID
	ID string `json:"id,required"`
	// Decimals of the asset
	Decimals int64 `json:"decimals,required"`
	// The Rune name
	Name string `json:"name,required"`
	// The Rune spaced name
	SpacedName string `json:"spaced_name,required"`
	// The Rune's symbol
	Symbol string `json:"symbol,required"`
	// URL of the asset's logo
	LogoURL string `json:"logo_url,nullable"`
	// Type of the asset (`RUNE`)
	Type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAssetType `json:"type"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAssetJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAsset) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAssetType added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAssetType string

Type of the asset (`RUNE`)

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAssetTypeRune BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAssetType = "RUNE"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffAssetType) IsKnown added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffIn added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffIn struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                                     `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffInJSON `json:"-"`
}

Details of the incoming transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffIn) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffOut added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffOut struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                                      `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffOutJSON `json:"-"`
}

Details of the outgoing transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryAccountAssetsDiffsBitcoinRunesAssetDiffOut) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryTotalUsdDiff added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryTotalUsdDiff struct {
	// Total incoming USD transfers
	In float64 `json:"in,required"`
	// Total outgoing USD transfers
	Out float64 `json:"out,required"`
	// Total USD transfers
	Total float64                                                                                       `json:"total"`
	JSON  bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryTotalUsdDiffJSON `json:"-"`
}

Total USD diff for the requested account address

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAccountSummaryTotalUsdDiff) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAddressDetail added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAddressDetail struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// Description of the account
	Description string                                                                           `json:"description,nullable"`
	JSON        bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAddressDetailJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAddressDetail) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiff added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiff struct {
	// This field can have the runtime type of
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAsset],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAsset],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAsset].
	Asset interface{} `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// This field can have the runtime type of
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffIn],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffIn],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffIn].
	In interface{} `json:"in"`
	// This field can have the runtime type of
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffOut],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffOut],
	// [BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffOut].
	Out  interface{}                                                                   `json:"out"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiff) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiff added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiff struct {
	Asset BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAsset `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffIn `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffOut  `json:"out,nullable"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiff) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAsset added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAsset struct {
	// The Inscription ID
	ID string `json:"id,required"`
	// Inscription's display name
	Name string `json:"name,required"`
	// The Inscription sat
	Sat int64 `json:"sat,required"`
	// URL of the asset's logo
	LogoURL string `json:"logo_url,nullable"`
	// Type of the asset (`INSCRIPTION`)
	Type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAssetType `json:"type"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAssetJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAsset) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAssetType added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAssetType string

Type of the asset (`INSCRIPTION`)

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAssetTypeInscription BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAssetType = "INSCRIPTION"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffAssetType) IsKnown added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffIn added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffIn struct {
	// Inscription ID of the transfer
	InscriptionID string `json:"inscription_id,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Summarized description of the transfer
	Summary string                                                                                                      `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffInJSON `json:"-"`
}

Details of the incoming transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffIn) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffOut added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffOut struct {
	// Inscription ID of the transfer
	InscriptionID string `json:"inscription_id,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Summarized description of the transfer
	Summary string                                                                                                       `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffOutJSON `json:"-"`
}

Details of the outgoing transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinInscriptionAssetDiffOut) UnmarshalJSON added in v0.34.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiff added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiff struct {
	Asset BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAsset `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffIn `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffOut  `json:"out,nullable"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiff) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAsset added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAsset struct {
	// URL of the asset's logo
	LogoURL string `json:"logo_url,required,nullable"`
	// Decimals of the asset
	Decimals BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetDecimals `json:"decimals"`
	// Name of the asset
	Name BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetName `json:"name"`
	// Symbol of the asset
	Symbol BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetSymbol `json:"symbol"`
	// Type of the asset (`NATIVE`)
	Type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetType `json:"type"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAsset) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetDecimals added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetDecimals int64

Decimals of the asset

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetDecimals8 BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetDecimals = 8
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetDecimals) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetName added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetName string

Name of the asset

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetNameBitcoin BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetName = "Bitcoin"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetName) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetSymbol added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetSymbol string

Symbol of the asset

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetSymbolBtc BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetSymbol = "BTC"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetSymbol) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetType added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetType string

Type of the asset (`NATIVE`)

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetTypeNative BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetType = "NATIVE"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffAssetType) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffIn added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffIn struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                 `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffInJSON `json:"-"`
}

Details of the incoming transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffIn) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffOut added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffOut struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                  `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffOutJSON `json:"-"`
}

Details of the outgoing transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinNativeAssetDiffOut) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiff added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiff struct {
	Asset BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAsset `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffIn `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffOut  `json:"out,nullable"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiff) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAsset added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAsset struct {
	// The Rune ID
	ID string `json:"id,required"`
	// Decimals of the asset
	Decimals int64 `json:"decimals,required"`
	// The Rune name
	Name string `json:"name,required"`
	// The Rune spaced name
	SpacedName string `json:"spaced_name,required"`
	// The Rune's symbol
	Symbol string `json:"symbol,required"`
	// URL of the asset's logo
	LogoURL string `json:"logo_url,nullable"`
	// Type of the asset (`RUNE`)
	Type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAssetType `json:"type"`
	JSON bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAssetJSON `json:"-"`
}

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAsset) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAssetType added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAssetType string

Type of the asset (`RUNE`)

const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAssetTypeRune BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAssetType = "RUNE"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffAssetType) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffIn added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffIn struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffInJSON `json:"-"`
}

Details of the incoming transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffIn) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffOut added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffOut struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                                                                                 `json:"summary,nullable"`
	JSON    bitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffOutJSON `json:"-"`
}

Details of the outgoing transfer

func (*BitcoinTransactionScanResponseSimulationBitcoinSimulationResultAssetsDiffsBitcoinRunesAssetDiffOut) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultStatus added in v0.29.0

type BitcoinTransactionScanResponseSimulationBitcoinSimulationResultStatus string
const (
	BitcoinTransactionScanResponseSimulationBitcoinSimulationResultStatusSuccess BitcoinTransactionScanResponseSimulationBitcoinSimulationResultStatus = "Success"
)

func (BitcoinTransactionScanResponseSimulationBitcoinSimulationResultStatus) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseSimulationStatus added in v0.20.0

type BitcoinTransactionScanResponseSimulationStatus string
const (
	BitcoinTransactionScanResponseSimulationStatusSuccess BitcoinTransactionScanResponseSimulationStatus = "Success"
	BitcoinTransactionScanResponseSimulationStatusError   BitcoinTransactionScanResponseSimulationStatus = "Error"
)

func (BitcoinTransactionScanResponseSimulationStatus) IsKnown added in v0.20.0

type BitcoinTransactionScanResponseSimulationUnion added in v0.20.0

type BitcoinTransactionScanResponseSimulationUnion interface {
	// contains filtered or unexported methods
}

Simulation result; Only present if simulation option is included in the request

Union satisfied by BitcoinTransactionScanResponseSimulationBitcoinSimulationResult or BitcoinTransactionScanResponseSimulationBitcoinSimulationErrorSchema.

type BitcoinTransactionScanResponseValidation added in v0.29.0

type BitcoinTransactionScanResponseValidation struct {
	Status BitcoinTransactionScanResponseValidationStatus `json:"status,required"`
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification"`
	// A textual description about the validation result
	Description string `json:"description"`
	// Error message
	Error string `json:"error"`
	// This field can have the runtime type of
	// [[]BitcoinTransactionScanResponseValidationBitcoinValidationResultFeature].
	Features interface{} `json:"features"`
	// A textual description about the reasons the transaction was flagged with
	// result_type
	Reason string `json:"reason"`
	// Verdict of the validation
	ResultType BitcoinTransactionScanResponseValidationResultType `json:"result_type"`
	JSON       bitcoinTransactionScanResponseValidationJSON       `json:"-"`
	// contains filtered or unexported fields
}

Validation result; Only present if validation option is included in the request

func (BitcoinTransactionScanResponseValidation) AsUnion added in v0.29.0

AsUnion returns a BitcoinTransactionScanResponseValidationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are BitcoinTransactionScanResponseValidationBitcoinValidationResult, BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchema.

func (*BitcoinTransactionScanResponseValidation) UnmarshalJSON added in v0.29.0

func (r *BitcoinTransactionScanResponseValidation) UnmarshalJSON(data []byte) (err error)

type BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchema added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchema struct {
	// Error message
	Error  string                                                                     `json:"error,required"`
	Status BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchemaStatus `json:"status,required"`
	JSON   bitcoinTransactionScanResponseValidationBitcoinValidationErrorSchemaJSON   `json:"-"`
}

func (*BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchema) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchemaStatus added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchemaStatus string
const (
	BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchemaStatusError BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchemaStatus = "Error"
)

func (BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchemaStatus) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResult added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResult struct {
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification,required"`
	// A textual description about the validation result
	Description string                                                                   `json:"description,required"`
	Features    []BitcoinTransactionScanResponseValidationBitcoinValidationResultFeature `json:"features,required"`
	// A textual description about the reasons the transaction was flagged with
	// result_type
	Reason string `json:"reason,required"`
	// Verdict of the validation
	ResultType BitcoinTransactionScanResponseValidationBitcoinValidationResultResultType `json:"result_type,required"`
	Status     BitcoinTransactionScanResponseValidationBitcoinValidationResultStatus     `json:"status,required"`
	JSON       bitcoinTransactionScanResponseValidationBitcoinValidationResultJSON       `json:"-"`
}

func (*BitcoinTransactionScanResponseValidationBitcoinValidationResult) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultFeature added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultFeature struct {
	// Address the feature refers to
	Address string `json:"address,required"`
	// Textual description
	Description string `json:"description,required"`
	FeatureID   string `json:"feature_id,required"`
	// Feature Classification
	Type BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType `json:"type,required"`
	JSON bitcoinTransactionScanResponseValidationBitcoinValidationResultFeatureJSON  `json:"-"`
}

func (*BitcoinTransactionScanResponseValidationBitcoinValidationResultFeature) UnmarshalJSON added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType string

Feature Classification

const (
	BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesTypeBenign    BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType = "Benign"
	BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesTypeWarning   BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType = "Warning"
	BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesTypeMalicious BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType = "Malicious"
	BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesTypeInfo      BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType = "Info"
)

func (BitcoinTransactionScanResponseValidationBitcoinValidationResultFeaturesType) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultResultType added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultResultType string

Verdict of the validation

const (
	BitcoinTransactionScanResponseValidationBitcoinValidationResultResultTypeBenign    BitcoinTransactionScanResponseValidationBitcoinValidationResultResultType = "Benign"
	BitcoinTransactionScanResponseValidationBitcoinValidationResultResultTypeWarning   BitcoinTransactionScanResponseValidationBitcoinValidationResultResultType = "Warning"
	BitcoinTransactionScanResponseValidationBitcoinValidationResultResultTypeMalicious BitcoinTransactionScanResponseValidationBitcoinValidationResultResultType = "Malicious"
)

func (BitcoinTransactionScanResponseValidationBitcoinValidationResultResultType) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultStatus added in v0.29.0

type BitcoinTransactionScanResponseValidationBitcoinValidationResultStatus string
const (
	BitcoinTransactionScanResponseValidationBitcoinValidationResultStatusSuccess BitcoinTransactionScanResponseValidationBitcoinValidationResultStatus = "Success"
)

func (BitcoinTransactionScanResponseValidationBitcoinValidationResultStatus) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseValidationResultType added in v0.29.0

type BitcoinTransactionScanResponseValidationResultType string

Verdict of the validation

const (
	BitcoinTransactionScanResponseValidationResultTypeBenign    BitcoinTransactionScanResponseValidationResultType = "Benign"
	BitcoinTransactionScanResponseValidationResultTypeWarning   BitcoinTransactionScanResponseValidationResultType = "Warning"
	BitcoinTransactionScanResponseValidationResultTypeMalicious BitcoinTransactionScanResponseValidationResultType = "Malicious"
)

func (BitcoinTransactionScanResponseValidationResultType) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseValidationStatus added in v0.29.0

type BitcoinTransactionScanResponseValidationStatus string
const (
	BitcoinTransactionScanResponseValidationStatusSuccess BitcoinTransactionScanResponseValidationStatus = "Success"
	BitcoinTransactionScanResponseValidationStatusError   BitcoinTransactionScanResponseValidationStatus = "Error"
)

func (BitcoinTransactionScanResponseValidationStatus) IsKnown added in v0.29.0

type BitcoinTransactionScanResponseValidationUnion added in v0.29.0

type BitcoinTransactionScanResponseValidationUnion interface {
	// contains filtered or unexported methods
}

Validation result; Only present if validation option is included in the request

Union satisfied by BitcoinTransactionScanResponseValidationBitcoinValidationResult or BitcoinTransactionScanResponseValidationBitcoinValidationErrorSchema.

type Client

type Client struct {
	Options   []option.RequestOption
	Evm       *EvmService
	Solana    *SolanaService
	Stellar   *StellarService
	Bitcoin   *BitcoinService
	Starknet  *StarknetService
	Site      *SiteService
	Scan      *ScanService
	Token     *TokenService
	TokenBulk *TokenBulkService
}

Client creates a struct with services and top level methods that help with interacting with the blockaid API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (BLOCKAID_CLIENT_API_KEY, BLOCKAID_CLIENT_ID_KEY). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete

func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute

func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned [url.Values] will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get

func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch

func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post

func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put

func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type CnftDetailsSchema added in v0.12.0

type CnftDetailsSchema struct {
	Address  string `json:"address,required"`
	Decimals int64  `json:"decimals,required"`
	Name     string `json:"name,required"`
	Symbol   string `json:"symbol,required"`
	// Type of the asset (`"CNFT"`)
	Type string                `json:"type"`
	JSON cnftDetailsSchemaJSON `json:"-"`
}

func (*CnftDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *CnftDetailsSchema) UnmarshalJSON(data []byte) (err error)

type CnftDiffSchema added in v0.12.0

type CnftDiffSchema struct {
	Asset CnftDetailsSchema `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// Incoming transfers of the asset
	In   AssetTransferDetailsSchema `json:"in,nullable"`
	Out  AssetTransferDetailsSchema `json:"out,nullable"`
	JSON cnftDiffSchemaJSON         `json:"-"`
}

func (*CnftDiffSchema) UnmarshalJSON added in v0.12.0

func (r *CnftDiffSchema) UnmarshalJSON(data []byte) (err error)

type CnftMintAccountDetailsSchema added in v0.12.0

type CnftMintAccountDetailsSchema struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// Name of the mint
	Name string `json:"name,required"`
	// Symbol of the mint
	Symbol string `json:"symbol,required"`
	// URI of the mint
	Uri string `json:"uri,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string `json:"description,nullable"`
	// Logo of the mint
	Type CnftMintAccountDetailsSchemaType `json:"type"`
	JSON cnftMintAccountDetailsSchemaJSON `json:"-"`
}

func (*CnftMintAccountDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *CnftMintAccountDetailsSchema) UnmarshalJSON(data []byte) (err error)

type CnftMintAccountDetailsSchemaType added in v0.12.0

type CnftMintAccountDetailsSchemaType string
const (
	CnftMintAccountDetailsSchemaTypeCnftMintAccount CnftMintAccountDetailsSchemaType = "CNFT_MINT_ACCOUNT"
)

func (CnftMintAccountDetailsSchemaType) IsKnown added in v0.12.0

type CombinedValidationResult added in v0.12.0

type CombinedValidationResult struct {
	// Transaction simulation result
	Simulation SuccessfulSimulationResultSchema `json:"simulation,nullable"`
	// Transaction validation result
	Validation CombinedValidationResultValidation `json:"validation,nullable"`
	JSON       combinedValidationResultJSON       `json:"-"`
}

func (*CombinedValidationResult) UnmarshalJSON added in v0.12.0

func (r *CombinedValidationResult) UnmarshalJSON(data []byte) (err error)

type CombinedValidationResultValidation added in v0.12.0

type CombinedValidationResultValidation struct {
	// A list of features explaining what is happening in the transaction in different
	// levels of severity
	ExtendedFeatures []ValidationFeature `json:"extended_features,required"`
	// A list of features about this transaction explaining the validation
	Features []string `json:"features,required"`
	// An enumeration.
	Reason CombinedValidationResultValidationReason `json:"reason,required"`
	// An enumeration.
	ResultType CombinedValidationResultValidationResultType `json:"result_type,required"`
	JSON       combinedValidationResultValidationJSON       `json:"-"`
}

Transaction validation result

func (*CombinedValidationResultValidation) UnmarshalJSON added in v0.12.0

func (r *CombinedValidationResultValidation) UnmarshalJSON(data []byte) (err error)

type CombinedValidationResultValidationReason added in v0.12.0

type CombinedValidationResultValidationReason string

An enumeration.

const (
	CombinedValidationResultValidationReasonEmpty                   CombinedValidationResultValidationReason = ""
	CombinedValidationResultValidationReasonSharedStateInBulk       CombinedValidationResultValidationReason = "shared_state_in_bulk"
	CombinedValidationResultValidationReasonUnknownProfiter         CombinedValidationResultValidationReason = "unknown_profiter"
	CombinedValidationResultValidationReasonUnfairTrade             CombinedValidationResultValidationReason = "unfair_trade"
	CombinedValidationResultValidationReasonTransferFarming         CombinedValidationResultValidationReason = "transfer_farming"
	CombinedValidationResultValidationReasonWritableAccountsFarming CombinedValidationResultValidationReason = "writable_accounts_farming"
	CombinedValidationResultValidationReasonNativeOwnershipChange   CombinedValidationResultValidationReason = "native_ownership_change"
	CombinedValidationResultValidationReasonSplTokenOwnershipChange CombinedValidationResultValidationReason = "spl_token_ownership_change"
	CombinedValidationResultValidationReasonExposureFarming         CombinedValidationResultValidationReason = "exposure_farming"
	CombinedValidationResultValidationReasonKnownAttacker           CombinedValidationResultValidationReason = "known_attacker"
	CombinedValidationResultValidationReasonInvalidSignature        CombinedValidationResultValidationReason = "invalid_signature"
	CombinedValidationResultValidationReasonOther                   CombinedValidationResultValidationReason = "other"
)

func (CombinedValidationResultValidationReason) IsKnown added in v0.12.0

type CombinedValidationResultValidationResultType added in v0.29.0

type CombinedValidationResultValidationResultType string

An enumeration.

const (
	CombinedValidationResultValidationResultTypeBenign    CombinedValidationResultValidationResultType = "Benign"
	CombinedValidationResultValidationResultTypeWarning   CombinedValidationResultValidationResultType = "Warning"
	CombinedValidationResultValidationResultTypeMalicious CombinedValidationResultValidationResultType = "Malicious"
)

func (CombinedValidationResultValidationResultType) IsKnown added in v0.29.0

type DelegatedAssetDetailsSchema added in v0.12.0

type DelegatedAssetDetailsSchema struct {
	Asset DelegatedAssetDetailsSchemaAsset `json:"asset,required"`
	// Type of the asset involved in the delegation
	AssetType string `json:"asset_type,required"`
	// The delegate's address
	Delegate string `json:"delegate,required"`
	// Details of the delegation
	Delegation AssetTransferDetailsSchema      `json:"delegation,required"`
	JSON       delegatedAssetDetailsSchemaJSON `json:"-"`
}

func (*DelegatedAssetDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *DelegatedAssetDetailsSchema) UnmarshalJSON(data []byte) (err error)

type DelegatedAssetDetailsSchemaAsset added in v0.12.0

type DelegatedAssetDetailsSchemaAsset struct {
	Address  string `json:"address,required"`
	Name     string `json:"name,required"`
	Symbol   string `json:"symbol,required"`
	Decimals int64  `json:"decimals"`
	// Type of the asset (`"TOKEN"`)
	Type string                               `json:"type"`
	JSON delegatedAssetDetailsSchemaAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

func (DelegatedAssetDetailsSchemaAsset) AsUnion added in v0.12.0

AsUnion returns a DelegatedAssetDetailsSchemaAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SplFungibleTokenDetailsSchema, SplNonFungibleTokenDetailsSchema, CnftDetailsSchema.

func (*DelegatedAssetDetailsSchemaAsset) UnmarshalJSON added in v0.12.0

func (r *DelegatedAssetDetailsSchemaAsset) UnmarshalJSON(data []byte) (err error)

type DelegatedAssetDetailsSchemaAssetUnion added in v0.12.0

type DelegatedAssetDetailsSchemaAssetUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SplFungibleTokenDetailsSchema, SplNonFungibleTokenDetailsSchema or CnftDetailsSchema.

type Erc1155Diff

type Erc1155Diff struct {
	// Indicates whether the token ID represents an arbitrary token from a collection,
	// unpredictable while running the simulation
	ArbitraryCollectionToken bool `json:"arbitrary_collection_token,required"`
	// id of the token
	TokenID string `json:"token_id,required"`
	// value before divided by decimal, that was transferred from this address
	Value string `json:"value,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// user friendly description of the asset transfer
	Summary string `json:"summary"`
	// usd equal of the asset that was transferred from this address
	UsdPrice string          `json:"usd_price"`
	JSON     erc1155DiffJSON `json:"-"`
}

func (*Erc1155Diff) UnmarshalJSON

func (r *Erc1155Diff) UnmarshalJSON(data []byte) (err error)

type Erc1155Exposure

type Erc1155Exposure struct {
	Exposure []Erc1155ExposureExposure `json:"exposure,required"`
	// boolean indicates whether an is_approved_for_all function was used (missing in
	// case of ERC20 / ERC1155)
	IsApprovedForAll bool `json:"is_approved_for_all,required"`
	// user friendly description of the approval
	Summary string              `json:"summary"`
	JSON    erc1155ExposureJSON `json:"-"`
}

func (*Erc1155Exposure) UnmarshalJSON

func (r *Erc1155Exposure) UnmarshalJSON(data []byte) (err error)

type Erc1155ExposureExposure

type Erc1155ExposureExposure struct {
	// Indicates whether the token ID represents an arbitrary token from a collection,
	// unpredictable while running the simulation
	ArbitraryCollectionToken bool `json:"arbitrary_collection_token"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// value before divided by decimal, that was transferred from this address
	RawValue string `json:"raw_value"`
	// user friendly description of the asset transfer
	Summary string `json:"summary"`
	// id of the token
	TokenID string `json:"token_id"`
	// usd equal of the asset that was transferred from this address
	UsdPrice string `json:"usd_price"`
	// value before divided by decimal, that was transferred from this address
	Value string                      `json:"value"`
	JSON  erc1155ExposureExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (Erc1155ExposureExposure) AsUnion

AsUnion returns a Erc1155ExposureExposureUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155Diff, Erc721Diff, Erc20Diff, NativeDiff.

func (*Erc1155ExposureExposure) UnmarshalJSON

func (r *Erc1155ExposureExposure) UnmarshalJSON(data []byte) (err error)

type Erc1155ExposureExposureUnion

type Erc1155ExposureExposureUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by Erc1155Diff, Erc721Diff, Erc20Diff or NativeDiff.

type Erc1155TokenDetails

type Erc1155TokenDetails struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type Erc1155TokenDetailsType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                  `json:"symbol"`
	JSON   erc1155TokenDetailsJSON `json:"-"`
}

func (*Erc1155TokenDetails) UnmarshalJSON

func (r *Erc1155TokenDetails) UnmarshalJSON(data []byte) (err error)

type Erc1155TokenDetailsType

type Erc1155TokenDetailsType string

asset type.

const (
	Erc1155TokenDetailsTypeErc1155 Erc1155TokenDetailsType = "ERC1155"
)

func (Erc1155TokenDetailsType) IsKnown

func (r Erc1155TokenDetailsType) IsKnown() bool

type Erc20Diff

type Erc20Diff struct {
	// value before divided by decimal, that was transferred from this address
	RawValue string `json:"raw_value,required"`
	// user friendly description of the asset transfer
	Summary string `json:"summary"`
	// usd equal of the asset that was transferred from this address
	UsdPrice string `json:"usd_price"`
	// value after divided by decimals, that was transferred from this address
	Value string        `json:"value"`
	JSON  erc20DiffJSON `json:"-"`
}

func (*Erc20Diff) UnmarshalJSON

func (r *Erc20Diff) UnmarshalJSON(data []byte) (err error)

type Erc20Exposure

type Erc20Exposure struct {
	// the amount that was asked in the approval request for this spender from the
	// current address and asset
	Approval string                  `json:"approval,required"`
	Exposure []Erc20ExposureExposure `json:"exposure,required"`
	// the expiration time of the permit2 protocol
	Expiration time.Time `json:"expiration" format:"date-time"`
	// user friendly description of the approval
	Summary string            `json:"summary"`
	JSON    erc20ExposureJSON `json:"-"`
}

func (*Erc20Exposure) UnmarshalJSON

func (r *Erc20Exposure) UnmarshalJSON(data []byte) (err error)

type Erc20ExposureExposure

type Erc20ExposureExposure struct {
	// Indicates whether the token ID represents an arbitrary token from a collection,
	// unpredictable while running the simulation
	ArbitraryCollectionToken bool `json:"arbitrary_collection_token"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// value before divided by decimal, that was transferred from this address
	RawValue string `json:"raw_value"`
	// user friendly description of the asset transfer
	Summary string `json:"summary"`
	// id of the token
	TokenID string `json:"token_id"`
	// usd equal of the asset that was transferred from this address
	UsdPrice string `json:"usd_price"`
	// value before divided by decimal, that was transferred from this address
	Value string                    `json:"value"`
	JSON  erc20ExposureExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (Erc20ExposureExposure) AsUnion

AsUnion returns a Erc20ExposureExposureUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155Diff, Erc721Diff, Erc20Diff, NativeDiff.

func (*Erc20ExposureExposure) UnmarshalJSON

func (r *Erc20ExposureExposure) UnmarshalJSON(data []byte) (err error)

type Erc20ExposureExposureUnion

type Erc20ExposureExposureUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by Erc1155Diff, Erc721Diff, Erc20Diff or NativeDiff.

type Erc20TokenDetails

type Erc20TokenDetails struct {
	// address of the token
	Address string `json:"address,required"`
	// asset's decimals
	Decimals int64 `json:"decimals,required"`
	// asset type.
	Type Erc20TokenDetailsType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                `json:"symbol"`
	JSON   erc20TokenDetailsJSON `json:"-"`
}

func (*Erc20TokenDetails) UnmarshalJSON

func (r *Erc20TokenDetails) UnmarshalJSON(data []byte) (err error)

type Erc20TokenDetailsType

type Erc20TokenDetailsType string

asset type.

const (
	Erc20TokenDetailsTypeErc20 Erc20TokenDetailsType = "ERC20"
)

func (Erc20TokenDetailsType) IsKnown

func (r Erc20TokenDetailsType) IsKnown() bool

type Erc721Diff

type Erc721Diff struct {
	// Indicates whether the token ID represents an arbitrary token from a collection,
	// unpredictable while running the simulation
	ArbitraryCollectionToken bool `json:"arbitrary_collection_token,required"`
	// id of the token
	TokenID string `json:"token_id,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// user friendly description of the asset transfer
	Summary string `json:"summary"`
	// usd equal of the asset that was transferred from this address
	UsdPrice string         `json:"usd_price"`
	JSON     erc721DiffJSON `json:"-"`
}

func (*Erc721Diff) UnmarshalJSON

func (r *Erc721Diff) UnmarshalJSON(data []byte) (err error)

type Erc721Exposure

type Erc721Exposure struct {
	Exposure []Erc721ExposureExposure `json:"exposure,required"`
	// boolean indicates whether an is_approved_for_all function was used (missing in
	// case of ERC20 / ERC1155)
	IsApprovedForAll bool `json:"is_approved_for_all,required"`
	// user friendly description of the approval
	Summary string             `json:"summary"`
	JSON    erc721ExposureJSON `json:"-"`
}

func (*Erc721Exposure) UnmarshalJSON

func (r *Erc721Exposure) UnmarshalJSON(data []byte) (err error)

type Erc721ExposureExposure

type Erc721ExposureExposure struct {
	// Indicates whether the token ID represents an arbitrary token from a collection,
	// unpredictable while running the simulation
	ArbitraryCollectionToken bool `json:"arbitrary_collection_token"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// value before divided by decimal, that was transferred from this address
	RawValue string `json:"raw_value"`
	// user friendly description of the asset transfer
	Summary string `json:"summary"`
	// id of the token
	TokenID string `json:"token_id"`
	// usd equal of the asset that was transferred from this address
	UsdPrice string `json:"usd_price"`
	// value before divided by decimal, that was transferred from this address
	Value string                     `json:"value"`
	JSON  erc721ExposureExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (Erc721ExposureExposure) AsUnion

AsUnion returns a Erc721ExposureExposureUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155Diff, Erc721Diff, Erc20Diff, NativeDiff.

func (*Erc721ExposureExposure) UnmarshalJSON

func (r *Erc721ExposureExposure) UnmarshalJSON(data []byte) (err error)

type Erc721ExposureExposureUnion

type Erc721ExposureExposureUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by Erc1155Diff, Erc721Diff, Erc20Diff or NativeDiff.

type Erc721TokenDetails

type Erc721TokenDetails struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type Erc721TokenDetailsType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                 `json:"symbol"`
	JSON   erc721TokenDetailsJSON `json:"-"`
}

func (*Erc721TokenDetails) UnmarshalJSON

func (r *Erc721TokenDetails) UnmarshalJSON(data []byte) (err error)

type Erc721TokenDetailsType

type Erc721TokenDetailsType string

asset type.

const (
	Erc721TokenDetailsTypeErc721 Erc721TokenDetailsType = "ERC721"
)

func (Erc721TokenDetailsType) IsKnown

func (r Erc721TokenDetailsType) IsKnown() bool

type Error

type Error = apierror.Error

type EvmJsonRpcScanParams

type EvmJsonRpcScanParams struct {
	// The chain name or chain ID
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// JSON-RPC request that was received by the wallet.
	Data param.Field[EvmJsonRpcScanParamsData] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
	// The address of the account (wallet) received the request in hex string format
	AccountAddress param.Field[string] `json:"account_address"`
	// The relative block for the block validation. Can be "latest" or a block number.
	Block param.Field[EvmJsonRpcScanParamsBlockUnion] `json:"block"`
	// list of one or both of options for the desired output. "simulation" - include
	// simulation output in your response. "validation" - include security validation
	// of the transaction in your response. Default is ["validation"]
	Options param.Field[[]EvmJsonRpcScanParamsOption] `json:"options"`
}

func (EvmJsonRpcScanParams) MarshalJSON

func (r EvmJsonRpcScanParams) MarshalJSON() (data []byte, err error)

type EvmJsonRpcScanParamsBlockUnion added in v0.13.0

type EvmJsonRpcScanParamsBlockUnion interface {
	ImplementsEvmJsonRpcScanParamsBlockUnion()
}

The relative block for the block validation. Can be "latest" or a block number.

Satisfied by shared.UnionInt, shared.UnionString.

type EvmJsonRpcScanParamsData

type EvmJsonRpcScanParamsData struct {
	// The method of the JSON-RPC request
	Method param.Field[string] `json:"method,required"`
	// The parameters of the JSON-RPC request in JSON format
	Params param.Field[[]interface{}] `json:"params,required"`
}

JSON-RPC request that was received by the wallet.

func (EvmJsonRpcScanParamsData) MarshalJSON

func (r EvmJsonRpcScanParamsData) MarshalJSON() (data []byte, err error)

type EvmJsonRpcScanParamsOption

type EvmJsonRpcScanParamsOption string

An enumeration.

const (
	EvmJsonRpcScanParamsOptionValidation    EvmJsonRpcScanParamsOption = "validation"
	EvmJsonRpcScanParamsOptionSimulation    EvmJsonRpcScanParamsOption = "simulation"
	EvmJsonRpcScanParamsOptionGasEstimation EvmJsonRpcScanParamsOption = "gas_estimation"
	EvmJsonRpcScanParamsOptionEvents        EvmJsonRpcScanParamsOption = "events"
)

func (EvmJsonRpcScanParamsOption) IsKnown

func (r EvmJsonRpcScanParamsOption) IsKnown() bool

type EvmJsonRpcService

type EvmJsonRpcService struct {
	Options []option.RequestOption
}

EvmJsonRpcService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmJsonRpcService method instead.

func NewEvmJsonRpcService

func NewEvmJsonRpcService(opts ...option.RequestOption) (r *EvmJsonRpcService)

NewEvmJsonRpcService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EvmJsonRpcService) Scan

Gets a json-rpc request and returns a full simulation indicating what will happen in the transaction together with a recommended action and some textual reasons of why the transaction was flagged that way.

type EvmPostTransactionBulkScanParams added in v0.11.0

type EvmPostTransactionBulkScanParams struct {
	// The chain name or chain ID
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// Transaction hashes to scan
	Data param.Field[[]string] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
	// The relative block for the block validation. Can be "latest" or a block number.
	Block param.Field[EvmPostTransactionBulkScanParamsBlockUnion] `json:"block"`
	// List of one or both of options for the desired output. "simulation" - include
	// simulation output in your response. "validation" - include security validation
	// of the transaction in your response. Default is ["validation"]
	Options param.Field[[]EvmPostTransactionBulkScanParamsOption] `json:"options"`
}

func (EvmPostTransactionBulkScanParams) MarshalJSON added in v0.11.0

func (r EvmPostTransactionBulkScanParams) MarshalJSON() (data []byte, err error)

type EvmPostTransactionBulkScanParamsBlockUnion added in v0.13.0

type EvmPostTransactionBulkScanParamsBlockUnion interface {
	ImplementsEvmPostTransactionBulkScanParamsBlockUnion()
}

The relative block for the block validation. Can be "latest" or a block number.

Satisfied by shared.UnionInt, shared.UnionString.

type EvmPostTransactionBulkScanParamsOption added in v0.11.0

type EvmPostTransactionBulkScanParamsOption string

An enumeration.

const (
	EvmPostTransactionBulkScanParamsOptionValidation    EvmPostTransactionBulkScanParamsOption = "validation"
	EvmPostTransactionBulkScanParamsOptionSimulation    EvmPostTransactionBulkScanParamsOption = "simulation"
	EvmPostTransactionBulkScanParamsOptionGasEstimation EvmPostTransactionBulkScanParamsOption = "gas_estimation"
	EvmPostTransactionBulkScanParamsOptionEvents        EvmPostTransactionBulkScanParamsOption = "events"
)

func (EvmPostTransactionBulkScanParamsOption) IsKnown added in v0.11.0

type EvmPostTransactionBulkService added in v0.11.0

type EvmPostTransactionBulkService struct {
	Options []option.RequestOption
}

EvmPostTransactionBulkService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmPostTransactionBulkService method instead.

func NewEvmPostTransactionBulkService added in v0.11.0

func NewEvmPostTransactionBulkService(opts ...option.RequestOption) (r *EvmPostTransactionBulkService)

NewEvmPostTransactionBulkService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EvmPostTransactionBulkService) Scan added in v0.11.0

Scan transactions that were already executed on chain, returns validation with features indicating address poisoning entites and malicious operators.

type EvmPostTransactionReportParams added in v0.15.0

type EvmPostTransactionReportParams struct {
	// Details about the report.
	Details param.Field[string] `json:"details,required"`
	// An enumeration.
	Event param.Field[EvmPostTransactionReportParamsEvent] `json:"event,required"`
	// The report parameters.
	Report param.Field[EvmPostTransactionReportParamsReportUnion] `json:"report,required"`
}

func (EvmPostTransactionReportParams) MarshalJSON added in v0.15.0

func (r EvmPostTransactionReportParams) MarshalJSON() (data []byte, err error)

type EvmPostTransactionReportParamsEvent added in v0.15.0

type EvmPostTransactionReportParamsEvent string

An enumeration.

const (
	EvmPostTransactionReportParamsEventFalsePositive EvmPostTransactionReportParamsEvent = "FALSE_POSITIVE"
	EvmPostTransactionReportParamsEventFalseNegative EvmPostTransactionReportParamsEvent = "FALSE_NEGATIVE"
)

func (EvmPostTransactionReportParamsEvent) IsKnown added in v0.15.0

type EvmPostTransactionReportParamsReport added in v0.15.0

type EvmPostTransactionReportParamsReport struct {
	Type      param.Field[EvmPostTransactionReportParamsReportType] `json:"type,required"`
	Params    param.Field[interface{}]                              `json:"params"`
	RequestID param.Field[string]                                   `json:"request_id"`
}

The report parameters.

func (EvmPostTransactionReportParamsReport) MarshalJSON added in v0.15.0

func (r EvmPostTransactionReportParamsReport) MarshalJSON() (data []byte, err error)

type EvmPostTransactionReportParamsReportParamReportChainTransactionHashParams added in v0.15.0

type EvmPostTransactionReportParamsReportParamReportChainTransactionHashParams struct {
	Params param.Field[EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsParams] `json:"params,required"`
	Type   param.Field[EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsType]   `json:"type,required"`
}

func (EvmPostTransactionReportParamsReportParamReportChainTransactionHashParams) MarshalJSON added in v0.15.0

type EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsParams added in v0.15.0

type EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsParams struct {
	// The chain name
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// The transaction hash to report on.
	TxHash param.Field[string] `json:"tx_hash,required"`
}

func (EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsParams) MarshalJSON added in v0.15.0

type EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsType added in v0.15.0

type EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsType string
const (
	EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsTypeParams EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsType = "params"
)

func (EvmPostTransactionReportParamsReportParamReportChainTransactionHashParamsType) IsKnown added in v0.15.0

type EvmPostTransactionReportParamsReportRequestIDReport added in v0.15.0

type EvmPostTransactionReportParamsReportRequestIDReport struct {
	RequestID param.Field[string]                                                  `json:"request_id,required"`
	Type      param.Field[EvmPostTransactionReportParamsReportRequestIDReportType] `json:"type,required"`
}

func (EvmPostTransactionReportParamsReportRequestIDReport) MarshalJSON added in v0.15.0

func (r EvmPostTransactionReportParamsReportRequestIDReport) MarshalJSON() (data []byte, err error)

type EvmPostTransactionReportParamsReportRequestIDReportType added in v0.15.0

type EvmPostTransactionReportParamsReportRequestIDReportType string
const (
	EvmPostTransactionReportParamsReportRequestIDReportTypeRequestID EvmPostTransactionReportParamsReportRequestIDReportType = "request_id"
)

func (EvmPostTransactionReportParamsReportRequestIDReportType) IsKnown added in v0.15.0

type EvmPostTransactionReportParamsReportType added in v0.15.0

type EvmPostTransactionReportParamsReportType string
const (
	EvmPostTransactionReportParamsReportTypeParams    EvmPostTransactionReportParamsReportType = "params"
	EvmPostTransactionReportParamsReportTypeRequestID EvmPostTransactionReportParamsReportType = "request_id"
)

func (EvmPostTransactionReportParamsReportType) IsKnown added in v0.15.0

type EvmPostTransactionReportParamsReportUnion added in v0.15.0

type EvmPostTransactionReportParamsReportUnion interface {
	// contains filtered or unexported methods
}

The report parameters.

Satisfied by EvmPostTransactionReportParamsReportParamReportChainTransactionHashParams, EvmPostTransactionReportParamsReportRequestIDReport, EvmPostTransactionReportParamsReport.

type EvmPostTransactionReportResponse added in v0.15.0

type EvmPostTransactionReportResponse = interface{}

type EvmPostTransactionScanParams added in v0.11.0

type EvmPostTransactionScanParams struct {
	// The chain name or chain ID
	Chain param.Field[TransactionScanSupportedChain]    `json:"chain,required"`
	Data  param.Field[EvmPostTransactionScanParamsData] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
	// The relative block for the block validation. Can be "latest" or a block number.
	Block param.Field[EvmPostTransactionScanParamsBlockUnion] `json:"block"`
	// list of one or both of options for the desired output. "simulation" - include
	// simulation output in your response. "validation" - include security validation
	// of the transaction in your response. Default is ["validation"]
	Options param.Field[[]EvmPostTransactionScanParamsOption] `json:"options"`
}

func (EvmPostTransactionScanParams) MarshalJSON added in v0.11.0

func (r EvmPostTransactionScanParams) MarshalJSON() (data []byte, err error)

type EvmPostTransactionScanParamsBlockUnion added in v0.13.0

type EvmPostTransactionScanParamsBlockUnion interface {
	ImplementsEvmPostTransactionScanParamsBlockUnion()
}

The relative block for the block validation. Can be "latest" or a block number.

Satisfied by shared.UnionInt, shared.UnionString.

type EvmPostTransactionScanParamsData added in v0.11.0

type EvmPostTransactionScanParamsData struct {
	// The transaction hash to scan
	TxHash param.Field[string] `json:"tx_hash,required"`
}

func (EvmPostTransactionScanParamsData) MarshalJSON added in v0.11.0

func (r EvmPostTransactionScanParamsData) MarshalJSON() (data []byte, err error)

type EvmPostTransactionScanParamsOption added in v0.11.0

type EvmPostTransactionScanParamsOption string

An enumeration.

const (
	EvmPostTransactionScanParamsOptionValidation    EvmPostTransactionScanParamsOption = "validation"
	EvmPostTransactionScanParamsOptionSimulation    EvmPostTransactionScanParamsOption = "simulation"
	EvmPostTransactionScanParamsOptionGasEstimation EvmPostTransactionScanParamsOption = "gas_estimation"
	EvmPostTransactionScanParamsOptionEvents        EvmPostTransactionScanParamsOption = "events"
)

func (EvmPostTransactionScanParamsOption) IsKnown added in v0.11.0

type EvmPostTransactionService added in v0.11.0

type EvmPostTransactionService struct {
	Options []option.RequestOption
}

EvmPostTransactionService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmPostTransactionService method instead.

func NewEvmPostTransactionService added in v0.11.0

func NewEvmPostTransactionService(opts ...option.RequestOption) (r *EvmPostTransactionService)

NewEvmPostTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EvmPostTransactionService) Report added in v0.15.0

Report for misclassification of an EVM post transaction.

func (*EvmPostTransactionService) Scan added in v0.11.0

Scan a transaction that was already executed on chain, returns validation with features indicating address poisoning entites and malicious operators.

type EvmService

type EvmService struct {
	Options             []option.RequestOption
	JsonRpc             *EvmJsonRpcService
	Transaction         *EvmTransactionService
	TransactionBulk     *EvmTransactionBulkService
	TransactionRaw      *EvmTransactionRawService
	UserOperation       *EvmUserOperationService
	PostTransaction     *EvmPostTransactionService
	PostTransactionBulk *EvmPostTransactionBulkService
}

EvmService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmService method instead.

func NewEvmService

func NewEvmService(opts ...option.RequestOption) (r *EvmService)

NewEvmService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type EvmTransactionBulkScanParams

type EvmTransactionBulkScanParams struct {
	// The chain name or chain ID
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// Transaction bulk parameters
	Data param.Field[[]EvmTransactionBulkScanParamsData] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
	// The relative block for the block validation. Can be "latest" or a block number.
	Block param.Field[EvmTransactionBulkScanParamsBlockUnion] `json:"block"`
	// List of one or both of options for the desired output. "simulation" - include
	// simulation output in your response. "validation" - include security validation
	// of the transaction in your response. Default is ["validation"]
	Options param.Field[[]EvmTransactionBulkScanParamsOption] `json:"options"`
}

func (EvmTransactionBulkScanParams) MarshalJSON

func (r EvmTransactionBulkScanParams) MarshalJSON() (data []byte, err error)

type EvmTransactionBulkScanParamsBlockUnion added in v0.13.0

type EvmTransactionBulkScanParamsBlockUnion interface {
	ImplementsEvmTransactionBulkScanParamsBlockUnion()
}

The relative block for the block validation. Can be "latest" or a block number.

Satisfied by shared.UnionInt, shared.UnionString.

type EvmTransactionBulkScanParamsData

type EvmTransactionBulkScanParamsData struct {
	// The source address of the transaction in hex string format
	From param.Field[string] `json:"from,required"`
	// The encoded call data of the transaction in hex string format
	Data param.Field[string] `json:"data"`
	// The gas required for the transaction in hex string format.
	Gas param.Field[string] `json:"gas"`
	// The gas price for the transaction in hex string format.
	GasPrice param.Field[string] `json:"gas_price"`
	// The destination address of the transaction in hex string format
	To param.Field[string] `json:"to"`
	// The value of the transaction in Wei in hex string format
	Value param.Field[string] `json:"value"`
}

func (EvmTransactionBulkScanParamsData) MarshalJSON

func (r EvmTransactionBulkScanParamsData) MarshalJSON() (data []byte, err error)

type EvmTransactionBulkScanParamsOption

type EvmTransactionBulkScanParamsOption string

An enumeration.

const (
	EvmTransactionBulkScanParamsOptionValidation    EvmTransactionBulkScanParamsOption = "validation"
	EvmTransactionBulkScanParamsOptionSimulation    EvmTransactionBulkScanParamsOption = "simulation"
	EvmTransactionBulkScanParamsOptionGasEstimation EvmTransactionBulkScanParamsOption = "gas_estimation"
	EvmTransactionBulkScanParamsOptionEvents        EvmTransactionBulkScanParamsOption = "events"
)

func (EvmTransactionBulkScanParamsOption) IsKnown

type EvmTransactionBulkService

type EvmTransactionBulkService struct {
	Options []option.RequestOption
}

EvmTransactionBulkService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmTransactionBulkService method instead.

func NewEvmTransactionBulkService

func NewEvmTransactionBulkService(opts ...option.RequestOption) (r *EvmTransactionBulkService)

NewEvmTransactionBulkService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EvmTransactionBulkService) Scan

Gets a bulk of transactions and returns a simulation showcasing the outcome after executing the transactions synchronously, along with a suggested course of action and textual explanations highlighting the reasons for flagging the bulk in that manner.

type EvmTransactionRawScanParams

type EvmTransactionRawScanParams struct {
	// The address to relate the transaction to. Account address determines in which
	// perspective the transaction is simulated and validated.
	AccountAddress param.Field[string] `json:"account_address,required"`
	// The chain name or chain ID
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// Hex string of the raw transaction data
	Data param.Field[string] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
	// The relative block for the block validation. Can be "latest" or a block number.
	Block param.Field[EvmTransactionRawScanParamsBlockUnion] `json:"block"`
	// list of one or both of options for the desired output. "simulation" - include
	// simulation output in your response. "validation" - include security validation
	// of the transaction in your response. Default is ["validation"]
	Options param.Field[[]EvmTransactionRawScanParamsOption] `json:"options"`
}

func (EvmTransactionRawScanParams) MarshalJSON

func (r EvmTransactionRawScanParams) MarshalJSON() (data []byte, err error)

type EvmTransactionRawScanParamsBlockUnion added in v0.13.0

type EvmTransactionRawScanParamsBlockUnion interface {
	ImplementsEvmTransactionRawScanParamsBlockUnion()
}

The relative block for the block validation. Can be "latest" or a block number.

Satisfied by shared.UnionInt, shared.UnionString.

type EvmTransactionRawScanParamsOption

type EvmTransactionRawScanParamsOption string

An enumeration.

const (
	EvmTransactionRawScanParamsOptionValidation    EvmTransactionRawScanParamsOption = "validation"
	EvmTransactionRawScanParamsOptionSimulation    EvmTransactionRawScanParamsOption = "simulation"
	EvmTransactionRawScanParamsOptionGasEstimation EvmTransactionRawScanParamsOption = "gas_estimation"
	EvmTransactionRawScanParamsOptionEvents        EvmTransactionRawScanParamsOption = "events"
)

func (EvmTransactionRawScanParamsOption) IsKnown

type EvmTransactionRawService

type EvmTransactionRawService struct {
	Options []option.RequestOption
}

EvmTransactionRawService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmTransactionRawService method instead.

func NewEvmTransactionRawService

func NewEvmTransactionRawService(opts ...option.RequestOption) (r *EvmTransactionRawService)

NewEvmTransactionRawService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EvmTransactionRawService) Scan

Gets a raw transaction and returns a full simulation indicating what will happen in the transaction together with a recommended action and some textual reasons of why the transaction was flagged that way.

type EvmTransactionReportParams added in v0.15.0

type EvmTransactionReportParams struct {
	// Details about the report.
	Details param.Field[string] `json:"details,required"`
	// An enumeration.
	Event param.Field[EvmTransactionReportParamsEvent] `json:"event,required"`
	// The report parameters.
	Report param.Field[EvmTransactionReportParamsReportUnion] `json:"report,required"`
}

func (EvmTransactionReportParams) MarshalJSON added in v0.15.0

func (r EvmTransactionReportParams) MarshalJSON() (data []byte, err error)

type EvmTransactionReportParamsEvent added in v0.15.0

type EvmTransactionReportParamsEvent string

An enumeration.

const (
	EvmTransactionReportParamsEventFalsePositive EvmTransactionReportParamsEvent = "FALSE_POSITIVE"
	EvmTransactionReportParamsEventFalseNegative EvmTransactionReportParamsEvent = "FALSE_NEGATIVE"
)

func (EvmTransactionReportParamsEvent) IsKnown added in v0.15.0

type EvmTransactionReportParamsReport added in v0.15.0

type EvmTransactionReportParamsReport struct {
	Type      param.Field[EvmTransactionReportParamsReportType] `json:"type,required"`
	Params    param.Field[interface{}]                          `json:"params"`
	RequestID param.Field[string]                               `json:"request_id"`
}

The report parameters.

func (EvmTransactionReportParamsReport) MarshalJSON added in v0.15.0

func (r EvmTransactionReportParamsReport) MarshalJSON() (data []byte, err error)

type EvmTransactionReportParamsReportParamReportTransactionReportParams added in v0.15.0

type EvmTransactionReportParamsReportParamReportTransactionReportParams struct {
	Params param.Field[EvmTransactionReportParamsReportParamReportTransactionReportParamsParams] `json:"params,required"`
	Type   param.Field[EvmTransactionReportParamsReportParamReportTransactionReportParamsType]   `json:"type,required"`
}

func (EvmTransactionReportParamsReportParamReportTransactionReportParams) MarshalJSON added in v0.15.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParams added in v0.15.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParams struct {
	// The address to relate the transaction to. Account address determines in which
	// perspective the transaction is simulated and validated.
	AccountAddress param.Field[string] `json:"account_address,required"`
	// The chain name
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// Transaction parameters
	Data param.Field[EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsDataUnion] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
}

func (EvmTransactionReportParamsReportParamReportTransactionReportParamsParams) MarshalJSON added in v0.15.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsData added in v0.16.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsData struct {
	// The encoded call data of the transaction in hex string format
	Data param.Field[string] `json:"data"`
	// The source address of the transaction in hex string format
	From param.Field[string] `json:"from"`
	// The gas required for the transaction in hex string format.
	Gas param.Field[string] `json:"gas"`
	// The gas price for the transaction in hex string format.
	GasPrice param.Field[string] `json:"gas_price"`
	// The method of the JSON-RPC request
	Method param.Field[string]      `json:"method"`
	Params param.Field[interface{}] `json:"params"`
	// The destination address of the transaction in hex string format
	To param.Field[string] `json:"to"`
	// The value of the transaction in Wei in hex string format
	Value param.Field[string] `json:"value"`
}

Transaction parameters

func (EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsData) MarshalJSON added in v0.16.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsDataJsonRpc added in v0.16.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsDataJsonRpc struct {
	// The method of the JSON-RPC request
	Method param.Field[string] `json:"method,required"`
	// The parameters of the JSON-RPC request in JSON format
	Params param.Field[[]interface{}] `json:"params,required"`
}

func (EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsDataJsonRpc) MarshalJSON added in v0.16.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsDataTransaction added in v0.16.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsDataTransaction struct {
	// The source address of the transaction in hex string format
	From param.Field[string] `json:"from,required"`
	// The encoded call data of the transaction in hex string format
	Data param.Field[string] `json:"data"`
	// The gas required for the transaction in hex string format.
	Gas param.Field[string] `json:"gas"`
	// The gas price for the transaction in hex string format.
	GasPrice param.Field[string] `json:"gas_price"`
	// The destination address of the transaction in hex string format
	To param.Field[string] `json:"to"`
	// The value of the transaction in Wei in hex string format
	Value param.Field[string] `json:"value"`
}

func (EvmTransactionReportParamsReportParamReportTransactionReportParamsParamsDataTransaction) MarshalJSON added in v0.16.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsType added in v0.15.0

type EvmTransactionReportParamsReportParamReportTransactionReportParamsType string
const (
	EvmTransactionReportParamsReportParamReportTransactionReportParamsTypeParams EvmTransactionReportParamsReportParamReportTransactionReportParamsType = "params"
)

func (EvmTransactionReportParamsReportParamReportTransactionReportParamsType) IsKnown added in v0.15.0

type EvmTransactionReportParamsReportRequestIDReport added in v0.15.0

type EvmTransactionReportParamsReportRequestIDReport struct {
	RequestID param.Field[string]                                              `json:"request_id,required"`
	Type      param.Field[EvmTransactionReportParamsReportRequestIDReportType] `json:"type,required"`
}

func (EvmTransactionReportParamsReportRequestIDReport) MarshalJSON added in v0.15.0

func (r EvmTransactionReportParamsReportRequestIDReport) MarshalJSON() (data []byte, err error)

type EvmTransactionReportParamsReportRequestIDReportType added in v0.15.0

type EvmTransactionReportParamsReportRequestIDReportType string
const (
	EvmTransactionReportParamsReportRequestIDReportTypeRequestID EvmTransactionReportParamsReportRequestIDReportType = "request_id"
)

func (EvmTransactionReportParamsReportRequestIDReportType) IsKnown added in v0.15.0

type EvmTransactionReportParamsReportType added in v0.15.0

type EvmTransactionReportParamsReportType string
const (
	EvmTransactionReportParamsReportTypeParams    EvmTransactionReportParamsReportType = "params"
	EvmTransactionReportParamsReportTypeRequestID EvmTransactionReportParamsReportType = "request_id"
)

func (EvmTransactionReportParamsReportType) IsKnown added in v0.15.0

type EvmTransactionReportParamsReportUnion added in v0.15.0

type EvmTransactionReportParamsReportUnion interface {
	// contains filtered or unexported methods
}

The report parameters.

Satisfied by EvmTransactionReportParamsReportParamReportTransactionReportParams, EvmTransactionReportParamsReportRequestIDReport, EvmTransactionReportParamsReport.

type EvmTransactionReportResponse added in v0.15.0

type EvmTransactionReportResponse = interface{}

type EvmTransactionScanParams

type EvmTransactionScanParams struct {
	// The address to relate the transaction to. Account address determines in which
	// perspective the transaction is simulated and validated.
	AccountAddress param.Field[string] `json:"account_address,required"`
	// The chain name or chain ID
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// Transaction parameters
	Data param.Field[EvmTransactionScanParamsData] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
	// The relative block for the block validation. Can be "latest" or a block number.
	Block param.Field[EvmTransactionScanParamsBlockUnion] `json:"block"`
	// list of one or both of options for the desired output. "simulation" - include
	// simulation output in your response. "validation" - include security validation
	// of the transaction in your response. Default is ["validation"]
	Options param.Field[[]EvmTransactionScanParamsOption] `json:"options"`
}

func (EvmTransactionScanParams) MarshalJSON

func (r EvmTransactionScanParams) MarshalJSON() (data []byte, err error)

type EvmTransactionScanParamsBlockUnion added in v0.13.0

type EvmTransactionScanParamsBlockUnion interface {
	ImplementsEvmTransactionScanParamsBlockUnion()
}

The relative block for the block validation. Can be "latest" or a block number.

Satisfied by shared.UnionInt, shared.UnionString.

type EvmTransactionScanParamsData

type EvmTransactionScanParamsData struct {
	// The source address of the transaction in hex string format
	From param.Field[string] `json:"from,required"`
	// The encoded call data of the transaction in hex string format
	Data param.Field[string] `json:"data"`
	// The gas required for the transaction in hex string format.
	Gas param.Field[string] `json:"gas"`
	// The gas price for the transaction in hex string format.
	GasPrice param.Field[string] `json:"gas_price"`
	// The destination address of the transaction in hex string format
	To param.Field[string] `json:"to"`
	// The value of the transaction in Wei in hex string format
	Value param.Field[string] `json:"value"`
}

Transaction parameters

func (EvmTransactionScanParamsData) MarshalJSON

func (r EvmTransactionScanParamsData) MarshalJSON() (data []byte, err error)

type EvmTransactionScanParamsOption

type EvmTransactionScanParamsOption string

An enumeration.

const (
	EvmTransactionScanParamsOptionValidation    EvmTransactionScanParamsOption = "validation"
	EvmTransactionScanParamsOptionSimulation    EvmTransactionScanParamsOption = "simulation"
	EvmTransactionScanParamsOptionGasEstimation EvmTransactionScanParamsOption = "gas_estimation"
	EvmTransactionScanParamsOptionEvents        EvmTransactionScanParamsOption = "events"
)

func (EvmTransactionScanParamsOption) IsKnown

type EvmTransactionService

type EvmTransactionService struct {
	Options []option.RequestOption
}

EvmTransactionService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmTransactionService method instead.

func NewEvmTransactionService

func NewEvmTransactionService(opts ...option.RequestOption) (r *EvmTransactionService)

NewEvmTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EvmTransactionService) Report added in v0.15.0

Report for misclassification of a transaction.

func (*EvmTransactionService) Scan

Gets a transaction and returns a full simulation indicating what will happen in the transaction together with a recommended action and some textual reasons of why the transaction was flagged that way.

type EvmUserOperationScanParams added in v0.7.0

type EvmUserOperationScanParams struct {
	// The chain name or chain ID
	Chain param.Field[TransactionScanSupportedChain] `json:"chain,required"`
	// The user operation request that was received by the wallet
	Data param.Field[EvmUserOperationScanParamsData] `json:"data,required"`
	// Object of additional information to validate against.
	Metadata param.Field[MetadataParam] `json:"metadata,required"`
	// The address of the account (wallet) sending the request in hex string format
	AccountAddress param.Field[string] `json:"account_address"`
	// The relative block for the block validation. Can be "latest" or a block number.
	Block param.Field[EvmUserOperationScanParamsBlockUnion] `json:"block"`
	// list of one or both of options for the desired output. "simulation" - include
	// simulation output in your response. "validation" - include security validation
	// of the transaction in your response. Default is ["validation"]
	Options param.Field[[]EvmUserOperationScanParamsOption] `json:"options"`
}

func (EvmUserOperationScanParams) MarshalJSON added in v0.7.0

func (r EvmUserOperationScanParams) MarshalJSON() (data []byte, err error)

type EvmUserOperationScanParamsBlockUnion added in v0.13.0

type EvmUserOperationScanParamsBlockUnion interface {
	ImplementsEvmUserOperationScanParamsBlockUnion()
}

The relative block for the block validation. Can be "latest" or a block number.

Satisfied by shared.UnionInt, shared.UnionString.

type EvmUserOperationScanParamsData added in v0.7.0

type EvmUserOperationScanParamsData struct {
	// The operation parameters of the user operation request
	Operation param.Field[EvmUserOperationScanParamsDataOperation] `json:"operation,required"`
	// The address of the entrypoint receiving the request in hex string format
	Entrypoint param.Field[string] `json:"entrypoint"`
}

The user operation request that was received by the wallet

func (EvmUserOperationScanParamsData) MarshalJSON added in v0.7.0

func (r EvmUserOperationScanParamsData) MarshalJSON() (data []byte, err error)

type EvmUserOperationScanParamsDataOperation added in v0.7.0

type EvmUserOperationScanParamsDataOperation struct {
	// The call data value in hex string format.
	CallData param.Field[string] `json:"call_data"`
	// The call gas limit value in hex string format.
	CallGasLimit param.Field[string] `json:"call_gas_limit"`
	// The init code value in hex string format.
	InitCode param.Field[string] `json:"init_code"`
	// The max fee per gas value in hex string format.
	MaxFeePerGas param.Field[string] `json:"max_fee_per_gas"`
	// The max priority fee per gas value in hex string format.
	MaxPriorityFeePerGas param.Field[string] `json:"max_priority_fee_per_gas"`
	// The nonce value in hex string format.
	Nonce param.Field[string] `json:"nonce"`
	// The paymaster and data value in hex string format.
	PaymasterAndData param.Field[string] `json:"paymaster_and_data"`
	// The pre verification gas value in hex string format.
	PreVerificationGas param.Field[string] `json:"pre_verification_gas"`
	// The sender address of the operation in hex string format
	Sender param.Field[string] `json:"sender"`
	// The signature value in hex string format.
	Signature param.Field[string] `json:"signature"`
	// The verification gas limit value in hex string format.
	VerificationGasLimit param.Field[string] `json:"verification_gas_limit"`
}

The operation parameters of the user operation request

func (EvmUserOperationScanParamsDataOperation) MarshalJSON added in v0.7.0

func (r EvmUserOperationScanParamsDataOperation) MarshalJSON() (data []byte, err error)

type EvmUserOperationScanParamsOption added in v0.7.0

type EvmUserOperationScanParamsOption string

An enumeration.

const (
	EvmUserOperationScanParamsOptionValidation    EvmUserOperationScanParamsOption = "validation"
	EvmUserOperationScanParamsOptionSimulation    EvmUserOperationScanParamsOption = "simulation"
	EvmUserOperationScanParamsOptionGasEstimation EvmUserOperationScanParamsOption = "gas_estimation"
	EvmUserOperationScanParamsOptionEvents        EvmUserOperationScanParamsOption = "events"
)

func (EvmUserOperationScanParamsOption) IsKnown added in v0.7.0

type EvmUserOperationService

type EvmUserOperationService struct {
	Options []option.RequestOption
}

EvmUserOperationService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewEvmUserOperationService method instead.

func NewEvmUserOperationService

func NewEvmUserOperationService(opts ...option.RequestOption) (r *EvmUserOperationService)

NewEvmUserOperationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*EvmUserOperationService) Scan added in v0.7.0

Gets a user operation request and returns a full simulation indicating what will happen in the transaction together with a recommended action and some textual reasons of why the transaction was flagged that way.

type FungibleMintAccountDetailsSchema added in v0.12.0

type FungibleMintAccountDetailsSchema struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// Name of the mint
	Name string `json:"name,required"`
	// Symbol of the mint
	Symbol string `json:"symbol,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string `json:"description,nullable"`
	// Logo of the mint
	Type FungibleMintAccountDetailsSchemaType `json:"type"`
	JSON fungibleMintAccountDetailsSchemaJSON `json:"-"`
}

func (*FungibleMintAccountDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *FungibleMintAccountDetailsSchema) UnmarshalJSON(data []byte) (err error)

type FungibleMintAccountDetailsSchemaType added in v0.12.0

type FungibleMintAccountDetailsSchemaType string
const (
	FungibleMintAccountDetailsSchemaTypeFungibleMintAccount FungibleMintAccountDetailsSchemaType = "FUNGIBLE_MINT_ACCOUNT"
)

func (FungibleMintAccountDetailsSchemaType) IsKnown added in v0.12.0

type InstructionErrorDetails added in v0.22.1

type InstructionErrorDetails struct {
	// Index of the instruction in the transaction
	InstructionIndex int64 `json:"instruction_index,required"`
	// Advanced message of the error
	Message string `json:"message,required"`
	// Index of the transaction in the bulk
	TransactionIndex int64 `json:"transaction_index,required"`
	// The program account that caused the error
	ProgramAccount string                      `json:"program_account,nullable"`
	Type           string                      `json:"type"`
	JSON           instructionErrorDetailsJSON `json:"-"`
}

func (*InstructionErrorDetails) UnmarshalJSON added in v0.22.1

func (r *InstructionErrorDetails) UnmarshalJSON(data []byte) (err error)

type MetadataParam

type MetadataParam struct {
	// cross reference transaction against the domain.
	Domain param.Field[string] `json:"domain,required"`
}

func (MetadataParam) MarshalJSON

func (r MetadataParam) MarshalJSON() (data []byte, err error)

type NativeAssetDetails added in v0.7.3

type NativeAssetDetails struct {
	ChainID   int64  `json:"chain_id,required"`
	ChainName string `json:"chain_name,required"`
	Decimals  int64  `json:"decimals,required"`
	LogoURL   string `json:"logo_url,required"`
	// asset type.
	Type NativeAssetDetailsType `json:"type,required"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                 `json:"symbol"`
	JSON   nativeAssetDetailsJSON `json:"-"`
}

func (*NativeAssetDetails) UnmarshalJSON added in v0.7.3

func (r *NativeAssetDetails) UnmarshalJSON(data []byte) (err error)

type NativeAssetDetailsType added in v0.7.3

type NativeAssetDetailsType string

asset type.

const (
	NativeAssetDetailsTypeNative NativeAssetDetailsType = "NATIVE"
)

func (NativeAssetDetailsType) IsKnown added in v0.7.3

func (r NativeAssetDetailsType) IsKnown() bool

type NativeDetailsSchema added in v0.29.0

type NativeDetailsSchema struct {
	Decimals int64 `json:"decimals"`
	Logo string `json:"logo,nullable"`
	// Type of the asset (`"NativeToken"`)
	Type string                  `json:"type"`
	JSON nativeDetailsSchemaJSON `json:"-"`
}

func (*NativeDetailsSchema) UnmarshalJSON added in v0.29.0

func (r *NativeDetailsSchema) UnmarshalJSON(data []byte) (err error)

type NativeDiff

type NativeDiff struct {
	// value before divided by decimal, that was transferred from this address
	RawValue string `json:"raw_value,required"`
	// user friendly description of the asset transfer
	Summary string `json:"summary"`
	// usd equal of the asset that was transferred from this address
	UsdPrice string `json:"usd_price"`
	// value after divided by decimals, that was transferred from this address
	Value string         `json:"value"`
	JSON  nativeDiffJSON `json:"-"`
}

func (*NativeDiff) UnmarshalJSON

func (r *NativeDiff) UnmarshalJSON(data []byte) (err error)

type NativeDiffSchema added in v0.29.0

type NativeDiffSchema struct {
	Asset NativeDetailsSchema `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// Incoming transfers of the asset
	In   AssetTransferDetailsSchema `json:"in,nullable"`
	Out  AssetTransferDetailsSchema `json:"out,nullable"`
	JSON nativeDiffSchemaJSON       `json:"-"`
}

func (*NativeDiffSchema) UnmarshalJSON added in v0.29.0

func (r *NativeDiffSchema) UnmarshalJSON(data []byte) (err error)

type NativeSolOwnershipDiffSchema added in v0.12.0

type NativeSolOwnershipDiffSchema struct {
	Asset NativeDetailsSchema `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// The owner post the transaction
	PostOwner string `json:"post_owner,required"`
	// Incoming transfers of the asset
	In AssetTransferDetailsSchema `json:"in_,nullable"`
	// Details of the moved value
	Out AssetTransferDetailsSchema `json:"out,nullable"`
	// The owner prior to the transaction
	PreOwner string                           `json:"pre_owner,nullable"`
	JSON     nativeSolOwnershipDiffSchemaJSON `json:"-"`
}

func (*NativeSolOwnershipDiffSchema) UnmarshalJSON added in v0.12.0

func (r *NativeSolOwnershipDiffSchema) UnmarshalJSON(data []byte) (err error)

type NonFungibleMintAccountDetailsSchema added in v0.12.0

type NonFungibleMintAccountDetailsSchema struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// Name of the mint
	Name string `json:"name,required"`
	// Symbol of the mint
	Symbol string `json:"symbol,required"`
	// URI of the mint
	Uri string `json:"uri,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string `json:"description,nullable"`
	// Logo of the mint
	Type NonFungibleMintAccountDetailsSchemaType `json:"type"`
	JSON nonFungibleMintAccountDetailsSchemaJSON `json:"-"`
}

func (*NonFungibleMintAccountDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *NonFungibleMintAccountDetailsSchema) UnmarshalJSON(data []byte) (err error)

type NonFungibleMintAccountDetailsSchemaType added in v0.12.0

type NonFungibleMintAccountDetailsSchemaType string
const (
	NonFungibleMintAccountDetailsSchemaTypeNonFungibleMintAccount NonFungibleMintAccountDetailsSchemaType = "NON_FUNGIBLE_MINT_ACCOUNT"
)

func (NonFungibleMintAccountDetailsSchemaType) IsKnown added in v0.12.0

type NonercTokenDetails

type NonercTokenDetails struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type NonercTokenDetailsType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                 `json:"symbol"`
	JSON   nonercTokenDetailsJSON `json:"-"`
}

func (*NonercTokenDetails) UnmarshalJSON

func (r *NonercTokenDetails) UnmarshalJSON(data []byte) (err error)

type NonercTokenDetailsType

type NonercTokenDetailsType string

asset type.

const (
	NonercTokenDetailsTypeNonerc NonercTokenDetailsType = "NONERC"
)

func (NonercTokenDetailsType) IsKnown

func (r NonercTokenDetailsType) IsKnown() bool

type PdaAccountSchema added in v0.12.0

type PdaAccountSchema struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// The address of the owning program
	Owner string `json:"owner,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string               `json:"description,nullable"`
	Type        PdaAccountSchemaType `json:"type"`
	JSON        pdaAccountSchemaJSON `json:"-"`
}

func (*PdaAccountSchema) UnmarshalJSON added in v0.12.0

func (r *PdaAccountSchema) UnmarshalJSON(data []byte) (err error)

type PdaAccountSchemaType added in v0.12.0

type PdaAccountSchemaType string
const (
	PdaAccountSchemaTypePda PdaAccountSchemaType = "PDA"
)

func (PdaAccountSchemaType) IsKnown added in v0.12.0

func (r PdaAccountSchemaType) IsKnown() bool

type ProgramAccountDetailsSchema added in v0.12.0

type ProgramAccountDetailsSchema struct {
	// Encoded public key of the account
	AccountAddress string                          `json:"account_address,required"`
	Type           ProgramAccountDetailsSchemaType `json:"type,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string                          `json:"description,nullable"`
	JSON        programAccountDetailsSchemaJSON `json:"-"`
}

func (*ProgramAccountDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *ProgramAccountDetailsSchema) UnmarshalJSON(data []byte) (err error)

type ProgramAccountDetailsSchemaType added in v0.12.0

type ProgramAccountDetailsSchemaType string
const (
	ProgramAccountDetailsSchemaTypeProgram       ProgramAccountDetailsSchemaType = "PROGRAM"
	ProgramAccountDetailsSchemaTypeNativeProgram ProgramAccountDetailsSchemaType = "NATIVE_PROGRAM"
)

func (ProgramAccountDetailsSchemaType) IsKnown added in v0.12.0

type ResponseSchema added in v0.12.0

type ResponseSchema struct {
	// Unique identifier of the request
	RequestID string `json:"request_id,required"`
	// An enumeration.
	Status ResponseSchemaStatus `json:"status,required"`
	// Encoding of the public keys
	Encoding string `json:"encoding"`
	// Error message if the simulation failed
	Error string `json:"error,nullable"`
	// Advanced error details
	ErrorDetails ResponseSchemaErrorDetails `json:"error_details,nullable"`
	// Summary of the result
	Result CombinedValidationResult `json:"result,nullable"`
	JSON   responseSchemaJSON       `json:"-"`
}

func (*ResponseSchema) UnmarshalJSON added in v0.12.0

func (r *ResponseSchema) UnmarshalJSON(data []byte) (err error)

type ResponseSchemaErrorDetails added in v0.22.1

type ResponseSchemaErrorDetails struct {
	// Advanced message of the error
	Message string `json:"message,required"`
	// Machine readable error code
	Code string `json:"code,nullable"`
	// Index of the instruction in the transaction
	InstructionIndex int64 `json:"instruction_index"`
	// Error number
	Number int64 `json:"number,nullable"`
	// The program account that caused the error
	ProgramAccount string `json:"program_account,nullable"`
	// Index of the transaction in the bulk
	TransactionIndex int64                          `json:"transaction_index"`
	Type             string                         `json:"type"`
	JSON             responseSchemaErrorDetailsJSON `json:"-"`
	// contains filtered or unexported fields
}

Advanced error details

func (ResponseSchemaErrorDetails) AsUnion added in v0.22.1

AsUnion returns a ResponseSchemaErrorDetailsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are APIErrorDetails, TransactionErrorDetails, InstructionErrorDetails.

func (*ResponseSchemaErrorDetails) UnmarshalJSON added in v0.22.1

func (r *ResponseSchemaErrorDetails) UnmarshalJSON(data []byte) (err error)

type ResponseSchemaErrorDetailsUnion added in v0.22.1

type ResponseSchemaErrorDetailsUnion interface {
	// contains filtered or unexported methods
}

Advanced error details

Union satisfied by APIErrorDetails, TransactionErrorDetails or InstructionErrorDetails.

type ResponseSchemaStatus added in v0.22.1

type ResponseSchemaStatus string

An enumeration.

const (
	ResponseSchemaStatusSuccess ResponseSchemaStatus = "SUCCESS"
	ResponseSchemaStatusError   ResponseSchemaStatus = "ERROR"
)

func (ResponseSchemaStatus) IsKnown added in v0.22.1

func (r ResponseSchemaStatus) IsKnown() bool

type ScanService added in v0.29.1

type ScanService struct {
	Options []option.RequestOption
}

ScanService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewScanService method instead.

func NewScanService added in v0.29.1

func NewScanService(opts ...option.RequestOption) (r *ScanService)

NewScanService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*ScanService) Status added in v0.29.1

func (r *ScanService) Status(ctx context.Context, body ScanStatusParams, opts ...option.RequestOption) (res *ScanStatusResponse, err error)

Report whether the end-user accepted the Blockaid classification on the entity being scanned.

type ScanStatusParams added in v0.29.1

type ScanStatusParams struct {
	// The x-request-id header returned from the previous Blockaid api request
	RequestID param.Field[string] `json:"request_id,required"`
	// An enumeration.
	Status param.Field[ScanStatusParamsStatus] `json:"status,required"`
}

func (ScanStatusParams) MarshalJSON added in v0.29.1

func (r ScanStatusParams) MarshalJSON() (data []byte, err error)

type ScanStatusParamsStatus added in v0.29.1

type ScanStatusParamsStatus string

An enumeration.

const (
	ScanStatusParamsStatusAccepted ScanStatusParamsStatus = "accepted"
	ScanStatusParamsStatusRejected ScanStatusParamsStatus = "rejected"
)

func (ScanStatusParamsStatus) IsKnown added in v0.29.1

func (r ScanStatusParamsStatus) IsKnown() bool

type ScanStatusResponse added in v0.29.1

type ScanStatusResponse = interface{}

type SiteReportParams added in v0.15.0

type SiteReportParams struct {
	// Details about the report.
	Details param.Field[string] `json:"details,required"`
	// An enumeration.
	Event param.Field[SiteReportParamsEvent] `json:"event,required"`
	// The report parameters.
	Report param.Field[SiteReportParamsReportUnion] `json:"report,required"`
}

func (SiteReportParams) MarshalJSON added in v0.15.0

func (r SiteReportParams) MarshalJSON() (data []byte, err error)

type SiteReportParamsEvent added in v0.15.0

type SiteReportParamsEvent string

An enumeration.

const (
	SiteReportParamsEventFalsePositive SiteReportParamsEvent = "FALSE_POSITIVE"
	SiteReportParamsEventFalseNegative SiteReportParamsEvent = "FALSE_NEGATIVE"
)

func (SiteReportParamsEvent) IsKnown added in v0.15.0

func (r SiteReportParamsEvent) IsKnown() bool

type SiteReportParamsReport added in v0.15.0

type SiteReportParamsReport struct {
	Type      param.Field[SiteReportParamsReportType] `json:"type,required"`
	Params    param.Field[interface{}]                `json:"params"`
	RequestID param.Field[string]                     `json:"request_id"`
}

The report parameters.

func (SiteReportParamsReport) MarshalJSON added in v0.15.0

func (r SiteReportParamsReport) MarshalJSON() (data []byte, err error)

type SiteReportParamsReportParamReportSiteReportParams added in v0.15.0

type SiteReportParamsReportParamReportSiteReportParams struct {
	Params param.Field[SiteReportParamsReportParamReportSiteReportParamsParams] `json:"params,required"`
	Type   param.Field[SiteReportParamsReportParamReportSiteReportParamsType]   `json:"type,required"`
}

func (SiteReportParamsReportParamReportSiteReportParams) MarshalJSON added in v0.15.0

func (r SiteReportParamsReportParamReportSiteReportParams) MarshalJSON() (data []byte, err error)

type SiteReportParamsReportParamReportSiteReportParamsParams added in v0.15.0

type SiteReportParamsReportParamReportSiteReportParamsParams struct {
	// The url of the site to report on.
	URL param.Field[string] `json:"url,required"`
}

func (SiteReportParamsReportParamReportSiteReportParamsParams) MarshalJSON added in v0.15.0

type SiteReportParamsReportParamReportSiteReportParamsType added in v0.15.0

type SiteReportParamsReportParamReportSiteReportParamsType string
const (
	SiteReportParamsReportParamReportSiteReportParamsTypeParams SiteReportParamsReportParamReportSiteReportParamsType = "params"
)

func (SiteReportParamsReportParamReportSiteReportParamsType) IsKnown added in v0.15.0

type SiteReportParamsReportRequestIDReport added in v0.15.0

type SiteReportParamsReportRequestIDReport struct {
	RequestID param.Field[string]                                    `json:"request_id,required"`
	Type      param.Field[SiteReportParamsReportRequestIDReportType] `json:"type,required"`
}

func (SiteReportParamsReportRequestIDReport) MarshalJSON added in v0.15.0

func (r SiteReportParamsReportRequestIDReport) MarshalJSON() (data []byte, err error)

type SiteReportParamsReportRequestIDReportType added in v0.15.0

type SiteReportParamsReportRequestIDReportType string
const (
	SiteReportParamsReportRequestIDReportTypeRequestID SiteReportParamsReportRequestIDReportType = "request_id"
)

func (SiteReportParamsReportRequestIDReportType) IsKnown added in v0.15.0

type SiteReportParamsReportType added in v0.15.0

type SiteReportParamsReportType string
const (
	SiteReportParamsReportTypeParams    SiteReportParamsReportType = "params"
	SiteReportParamsReportTypeRequestID SiteReportParamsReportType = "request_id"
)

func (SiteReportParamsReportType) IsKnown added in v0.15.0

func (r SiteReportParamsReportType) IsKnown() bool

type SiteReportParamsReportUnion added in v0.15.0

type SiteReportParamsReportUnion interface {
	// contains filtered or unexported methods
}

The report parameters.

Satisfied by SiteReportParamsReportParamReportSiteReportParams, SiteReportParamsReportRequestIDReport, SiteReportParamsReport.

type SiteReportResponse added in v0.15.0

type SiteReportResponse = interface{}

type SiteScanHitResponse

type SiteScanHitResponse struct {
	AttackTypes       map[string]SiteScanHitResponseAttackType `json:"attack_types,required"`
	ContractRead      SiteScanHitResponseContractRead          `json:"contract_read,required"`
	ContractWrite     SiteScanHitResponseContractWrite         `json:"contract_write,required"`
	IsMalicious       bool                                     `json:"is_malicious,required"`
	IsReachable       bool                                     `json:"is_reachable,required"`
	IsWeb3Site        bool                                     `json:"is_web3_site,required"`
	JsonRpcOperations []string                                 `json:"json_rpc_operations,required"`
	MaliciousScore    float64                                  `json:"malicious_score,required"`
	NetworkOperations []string                                 `json:"network_operations,required"`
	ScanEndTime       time.Time                                `json:"scan_end_time,required" format:"date-time"`
	ScanStartTime     time.Time                                `json:"scan_start_time,required" format:"date-time"`
	Status            SiteScanHitResponseStatus                `json:"status,required"`
	URL               string                                   `json:"url,required"`
	JSON              siteScanHitResponseJSON                  `json:"-"`
}

func (*SiteScanHitResponse) UnmarshalJSON

func (r *SiteScanHitResponse) UnmarshalJSON(data []byte) (err error)

type SiteScanHitResponseAttackType

type SiteScanHitResponseAttackType struct {
	Score     float64                           `json:"score,required"`
	Threshold float64                           `json:"threshold,required"`
	JSON      siteScanHitResponseAttackTypeJSON `json:"-"`
}

func (*SiteScanHitResponseAttackType) UnmarshalJSON

func (r *SiteScanHitResponseAttackType) UnmarshalJSON(data []byte) (err error)

type SiteScanHitResponseContractRead

type SiteScanHitResponseContractRead struct {
	ContractAddresses []string                            `json:"contract_addresses,required"`
	Functions         map[string][]string                 `json:"functions,required"`
	JSON              siteScanHitResponseContractReadJSON `json:"-"`
}

func (*SiteScanHitResponseContractRead) UnmarshalJSON

func (r *SiteScanHitResponseContractRead) UnmarshalJSON(data []byte) (err error)

type SiteScanHitResponseContractWrite

type SiteScanHitResponseContractWrite struct {
	ContractAddresses []string                             `json:"contract_addresses,required"`
	Functions         map[string][]string                  `json:"functions,required"`
	JSON              siteScanHitResponseContractWriteJSON `json:"-"`
}

func (*SiteScanHitResponseContractWrite) UnmarshalJSON

func (r *SiteScanHitResponseContractWrite) UnmarshalJSON(data []byte) (err error)

type SiteScanHitResponseStatus

type SiteScanHitResponseStatus string
const (
	SiteScanHitResponseStatusHit SiteScanHitResponseStatus = "hit"
)

func (SiteScanHitResponseStatus) IsKnown

func (r SiteScanHitResponseStatus) IsKnown() bool

type SiteScanMissResponse

type SiteScanMissResponse struct {
	Status SiteScanMissResponseStatus `json:"status,required"`
	JSON   siteScanMissResponseJSON   `json:"-"`
}

func (*SiteScanMissResponse) UnmarshalJSON

func (r *SiteScanMissResponse) UnmarshalJSON(data []byte) (err error)

type SiteScanMissResponseStatus

type SiteScanMissResponseStatus string
const (
	SiteScanMissResponseStatusMiss SiteScanMissResponseStatus = "miss"
)

func (SiteScanMissResponseStatus) IsKnown

func (r SiteScanMissResponseStatus) IsKnown() bool

type SiteScanParams

type SiteScanParams struct {
	URL      param.Field[string]                      `json:"url,required"`
	Metadata param.Field[SiteScanParamsMetadataUnion] `json:"metadata"`
}

func (SiteScanParams) MarshalJSON

func (r SiteScanParams) MarshalJSON() (data []byte, err error)

type SiteScanParamsMetadata

type SiteScanParamsMetadata struct {
	Type                     param.Field[SiteScanParamsMetadataType] `json:"type,required"`
	AccountAddress           param.Field[string]                     `json:"account_address"`
	AccountAddresses         param.Field[interface{}]                `json:"account_addresses"`
	WalletconnectDescription param.Field[string]                     `json:"walletconnect_description"`
	WalletconnectName        param.Field[string]                     `json:"walletconnect_name"`
}

func (SiteScanParamsMetadata) MarshalJSON

func (r SiteScanParamsMetadata) MarshalJSON() (data []byte, err error)

type SiteScanParamsMetadataCatalogRequestMetadata

type SiteScanParamsMetadataCatalogRequestMetadata struct {
	Type param.Field[SiteScanParamsMetadataCatalogRequestMetadataType] `json:"type,required"`
}

func (SiteScanParamsMetadataCatalogRequestMetadata) MarshalJSON

func (r SiteScanParamsMetadataCatalogRequestMetadata) MarshalJSON() (data []byte, err error)

type SiteScanParamsMetadataCatalogRequestMetadataType

type SiteScanParamsMetadataCatalogRequestMetadataType string
const (
	SiteScanParamsMetadataCatalogRequestMetadataTypeCatalog SiteScanParamsMetadataCatalogRequestMetadataType = "catalog"
)

func (SiteScanParamsMetadataCatalogRequestMetadataType) IsKnown

type SiteScanParamsMetadataMultipleWalletRequestMetadata added in v0.27.3

type SiteScanParamsMetadataMultipleWalletRequestMetadata struct {
	// List of all account addresses in different chains based on the CAIPs standard
	// (https://github.com/ChainAgnostic/CAIPs). Ethereum mainnet example:
	// eip155:1:0xab16a96d359ec26a11e2c2b3d8f8b8942d5bfcdb
	AccountAddresses         param.Field[[]string]                                                `json:"account_addresses,required"`
	Type                     param.Field[SiteScanParamsMetadataMultipleWalletRequestMetadataType] `json:"type,required"`
	WalletconnectDescription param.Field[string]                                                  `json:"walletconnect_description"`
	WalletconnectName        param.Field[string]                                                  `json:"walletconnect_name"`
}

func (SiteScanParamsMetadataMultipleWalletRequestMetadata) MarshalJSON added in v0.27.3

func (r SiteScanParamsMetadataMultipleWalletRequestMetadata) MarshalJSON() (data []byte, err error)

type SiteScanParamsMetadataMultipleWalletRequestMetadataType added in v0.27.3

type SiteScanParamsMetadataMultipleWalletRequestMetadataType string
const (
	SiteScanParamsMetadataMultipleWalletRequestMetadataTypeWallet SiteScanParamsMetadataMultipleWalletRequestMetadataType = "wallet"
)

func (SiteScanParamsMetadataMultipleWalletRequestMetadataType) IsKnown added in v0.27.3

type SiteScanParamsMetadataType

type SiteScanParamsMetadataType string
const (
	SiteScanParamsMetadataTypeCatalog SiteScanParamsMetadataType = "catalog"
	SiteScanParamsMetadataTypeWallet  SiteScanParamsMetadataType = "wallet"
)

func (SiteScanParamsMetadataType) IsKnown

func (r SiteScanParamsMetadataType) IsKnown() bool

type SiteScanParamsMetadataWalletRequestMetadata

type SiteScanParamsMetadataWalletRequestMetadata struct {
	AccountAddress           param.Field[string]                                          `json:"account_address,required"`
	Type                     param.Field[SiteScanParamsMetadataWalletRequestMetadataType] `json:"type,required"`
	WalletconnectDescription param.Field[string]                                          `json:"walletconnect_description"`
	WalletconnectName        param.Field[string]                                          `json:"walletconnect_name"`
}

func (SiteScanParamsMetadataWalletRequestMetadata) MarshalJSON

func (r SiteScanParamsMetadataWalletRequestMetadata) MarshalJSON() (data []byte, err error)

type SiteScanParamsMetadataWalletRequestMetadataType

type SiteScanParamsMetadataWalletRequestMetadataType string
const (
	SiteScanParamsMetadataWalletRequestMetadataTypeWallet SiteScanParamsMetadataWalletRequestMetadataType = "wallet"
)

func (SiteScanParamsMetadataWalletRequestMetadataType) IsKnown

type SiteScanResponse

type SiteScanResponse struct {
	Status SiteScanResponseStatus `json:"status,required"`
	// This field can have the runtime type of
	// [map[string]SiteScanHitResponseAttackType].
	AttackTypes interface{} `json:"attack_types"`
	// This field can have the runtime type of [SiteScanHitResponseContractRead].
	ContractRead interface{} `json:"contract_read"`
	// This field can have the runtime type of [SiteScanHitResponseContractWrite].
	ContractWrite interface{} `json:"contract_write"`
	IsMalicious   bool        `json:"is_malicious"`
	IsReachable   bool        `json:"is_reachable"`
	IsWeb3Site    bool        `json:"is_web3_site"`
	// This field can have the runtime type of [[]string].
	JsonRpcOperations interface{} `json:"json_rpc_operations"`
	MaliciousScore    float64     `json:"malicious_score"`
	// This field can have the runtime type of [[]string].
	NetworkOperations interface{}          `json:"network_operations"`
	ScanEndTime       time.Time            `json:"scan_end_time" format:"date-time"`
	ScanStartTime     time.Time            `json:"scan_start_time" format:"date-time"`
	URL               string               `json:"url"`
	JSON              siteScanResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (SiteScanResponse) AsUnion

AsUnion returns a SiteScanResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SiteScanHitResponse, SiteScanMissResponse.

func (*SiteScanResponse) UnmarshalJSON

func (r *SiteScanResponse) UnmarshalJSON(data []byte) (err error)

type SiteScanResponseStatus

type SiteScanResponseStatus string
const (
	SiteScanResponseStatusHit  SiteScanResponseStatus = "hit"
	SiteScanResponseStatusMiss SiteScanResponseStatus = "miss"
)

func (SiteScanResponseStatus) IsKnown

func (r SiteScanResponseStatus) IsKnown() bool

type SiteScanResponseUnion

type SiteScanResponseUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SiteScanHitResponse or SiteScanMissResponse.

type SiteService

type SiteService struct {
	Options []option.RequestOption
}

SiteService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSiteService method instead.

func NewSiteService

func NewSiteService(opts ...option.RequestOption) (r *SiteService)

NewSiteService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SiteService) Report added in v0.15.0

func (r *SiteService) Report(ctx context.Context, body SiteReportParams, opts ...option.RequestOption) (res *SiteReportResponse, err error)

Report for misclassification of a site.

func (*SiteService) Scan

func (r *SiteService) Scan(ctx context.Context, body SiteScanParams, opts ...option.RequestOption) (res *SiteScanResponse, err error)

Scan Site

type SolanaAddressScanParams added in v0.12.0

type SolanaAddressScanParams struct {
	AddressScanRequestSchema AddressScanRequestSchemaParam `json:"AddressScanRequestSchema,required"`
}

func (SolanaAddressScanParams) MarshalJSON added in v0.12.0

func (r SolanaAddressScanParams) MarshalJSON() (data []byte, err error)

type SolanaAddressService added in v0.12.0

type SolanaAddressService struct {
	Options []option.RequestOption
}

SolanaAddressService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSolanaAddressService method instead.

func NewSolanaAddressService added in v0.12.0

func NewSolanaAddressService(opts ...option.RequestOption) (r *SolanaAddressService)

NewSolanaAddressService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SolanaAddressService) Scan added in v0.12.0

Gets an address and returns a full security assessment indicating weather or not this address is malicious as well as textual reasons of why the address was flagged that way.

type SolanaMessageScanParams added in v0.12.0

type SolanaMessageScanParams struct {
	TxScanRequestSchema TxScanRequestSchemaParam `json:"TxScanRequestSchema,required"`
}

func (SolanaMessageScanParams) MarshalJSON added in v0.12.0

func (r SolanaMessageScanParams) MarshalJSON() (data []byte, err error)

type SolanaMessageService added in v0.12.0

type SolanaMessageService struct {
	Options []option.RequestOption
}

SolanaMessageService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSolanaMessageService method instead.

func NewSolanaMessageService added in v0.12.0

func NewSolanaMessageService(opts ...option.RequestOption) (r *SolanaMessageService)

NewSolanaMessageService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*SolanaMessageService) Scan added in v0.12.0

Scan Messages

type SolanaService added in v0.12.0

type SolanaService struct {
	Options []option.RequestOption
	Message *SolanaMessageService
	Address *SolanaAddressService
}

SolanaService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewSolanaService method instead.

func NewSolanaService added in v0.12.0

func NewSolanaService(opts ...option.RequestOption) (r *SolanaService)

NewSolanaService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type SplFungibleTokenDetailsSchema added in v0.12.0

type SplFungibleTokenDetailsSchema struct {
	Address  string `json:"address,required"`
	Decimals int64  `json:"decimals,required"`
	Name     string `json:"name,required"`
	Symbol   string `json:"symbol,required"`
	// Type of the asset (`"TOKEN"`)
	Type string                            `json:"type"`
	JSON splFungibleTokenDetailsSchemaJSON `json:"-"`
}

func (*SplFungibleTokenDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *SplFungibleTokenDetailsSchema) UnmarshalJSON(data []byte) (err error)

type SplFungibleTokenDiffSchema added in v0.12.0

type SplFungibleTokenDiffSchema struct {
	Asset SplFungibleTokenDetailsSchema `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// Incoming transfers of the asset
	In   AssetTransferDetailsSchema     `json:"in,nullable"`
	Out  AssetTransferDetailsSchema     `json:"out,nullable"`
	JSON splFungibleTokenDiffSchemaJSON `json:"-"`
}

func (*SplFungibleTokenDiffSchema) UnmarshalJSON added in v0.12.0

func (r *SplFungibleTokenDiffSchema) UnmarshalJSON(data []byte) (err error)

type SplNonFungibleTokenDetailsSchema added in v0.12.0

type SplNonFungibleTokenDetailsSchema struct {
	Address  string `json:"address,required"`
	Name     string `json:"name,required"`
	Symbol   string `json:"symbol,required"`
	Decimals int64  `json:"decimals"`
	// Type of the asset (`"NFT"`)
	Type string                               `json:"type"`
	JSON splNonFungibleTokenDetailsSchemaJSON `json:"-"`
}

func (*SplNonFungibleTokenDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *SplNonFungibleTokenDetailsSchema) UnmarshalJSON(data []byte) (err error)

type SplNonFungibleTokenDiffSchema added in v0.12.0

type SplNonFungibleTokenDiffSchema struct {
	Asset SplNonFungibleTokenDetailsSchema `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// Incoming transfers of the asset
	In   AssetTransferDetailsSchema        `json:"in,nullable"`
	Out  AssetTransferDetailsSchema        `json:"out,nullable"`
	JSON splNonFungibleTokenDiffSchemaJSON `json:"-"`
}

func (*SplNonFungibleTokenDiffSchema) UnmarshalJSON added in v0.12.0

func (r *SplNonFungibleTokenDiffSchema) UnmarshalJSON(data []byte) (err error)

type SplTokenOwnershipDiffSchema added in v0.12.0

type SplTokenOwnershipDiffSchema struct {
	Asset SplTokenOwnershipDiffSchemaAsset `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// The owner post the transaction
	PostOwner string `json:"post_owner,required"`
	// Incoming transfers of the asset
	In AssetTransferDetailsSchema `json:"in_,nullable"`
	// Details of the moved value
	Out AssetTransferDetailsSchema `json:"out,nullable"`
	// The owner prior to the transaction
	PreOwner string                          `json:"pre_owner,nullable"`
	JSON     splTokenOwnershipDiffSchemaJSON `json:"-"`
}

func (*SplTokenOwnershipDiffSchema) UnmarshalJSON added in v0.12.0

func (r *SplTokenOwnershipDiffSchema) UnmarshalJSON(data []byte) (err error)

type SplTokenOwnershipDiffSchemaAsset added in v0.12.0

type SplTokenOwnershipDiffSchemaAsset struct {
	Address  string `json:"address,required"`
	Name     string `json:"name,required"`
	Symbol   string `json:"symbol,required"`
	Decimals int64  `json:"decimals"`
	// Type of the asset (`"TOKEN"`)
	Type string                               `json:"type"`
	JSON splTokenOwnershipDiffSchemaAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

func (SplTokenOwnershipDiffSchemaAsset) AsUnion added in v0.12.0

AsUnion returns a SplTokenOwnershipDiffSchemaAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SplFungibleTokenDetailsSchema, SplNonFungibleTokenDetailsSchema.

func (*SplTokenOwnershipDiffSchemaAsset) UnmarshalJSON added in v0.12.0

func (r *SplTokenOwnershipDiffSchemaAsset) UnmarshalJSON(data []byte) (err error)

type SplTokenOwnershipDiffSchemaAssetUnion added in v0.12.0

type SplTokenOwnershipDiffSchemaAssetUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SplFungibleTokenDetailsSchema or SplNonFungibleTokenDetailsSchema.

type StakedAssetDetailsSchema added in v0.29.0

type StakedAssetDetailsSchema struct {
	Decimals int64 `json:"decimals"`
	Logo string `json:"logo,nullable"`
	// Type of the asset (`"STAKED_NATIVE"`)
	Type string                       `json:"type"`
	JSON stakedAssetDetailsSchemaJSON `json:"-"`
}

func (*StakedAssetDetailsSchema) UnmarshalJSON added in v0.29.0

func (r *StakedAssetDetailsSchema) UnmarshalJSON(data []byte) (err error)

type StakedSolWithdrawAuthorityDiffSchema added in v0.12.0

type StakedSolWithdrawAuthorityDiffSchema struct {
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// The owner post the transaction
	PostOwner string                   `json:"post_owner,required"`
	Asset     StakedAssetDetailsSchema `json:"asset"`
	// Incoming transfers of the asset
	In AssetTransferDetailsSchema `json:"in_,nullable"`
	// Details of the moved value
	Out AssetTransferDetailsSchema `json:"out,nullable"`
	// The owner prior to the transaction
	PreOwner string                                   `json:"pre_owner,nullable"`
	JSON     stakedSolWithdrawAuthorityDiffSchemaJSON `json:"-"`
}

func (*StakedSolWithdrawAuthorityDiffSchema) UnmarshalJSON added in v0.12.0

func (r *StakedSolWithdrawAuthorityDiffSchema) UnmarshalJSON(data []byte) (err error)

type StarknetErc1155Details added in v0.22.1

type StarknetErc1155Details struct {
	// Address of the token's contract
	Address string `json:"address,required"`
	// token's name
	Name string `json:"name,required"`
	// token's symbol
	Symbol string `json:"symbol,required"`
	// URL of the asset's logo
	LogoURL string `json:"logo_url,nullable"`
	// Type of the asset (`ERC1155`)
	Type StarknetErc1155DetailsType `json:"type"`
	JSON starknetErc1155DetailsJSON `json:"-"`
}

func (*StarknetErc1155Details) UnmarshalJSON added in v0.22.1

func (r *StarknetErc1155Details) UnmarshalJSON(data []byte) (err error)

type StarknetErc1155DetailsType added in v0.22.1

type StarknetErc1155DetailsType string

Type of the asset (`ERC1155`)

const (
	StarknetErc1155DetailsTypeErc1155 StarknetErc1155DetailsType = "ERC1155"
)

func (StarknetErc1155DetailsType) IsKnown added in v0.22.1

func (r StarknetErc1155DetailsType) IsKnown() bool

type StarknetErc1155Diff added in v0.22.1

type StarknetErc1155Diff struct {
	// Token ID of the transfer
	TokenID string `json:"token_id,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value int64 `json:"value,required"`
	// Summarized description of the transfer
	Summary string                  `json:"summary,nullable"`
	JSON    starknetErc1155DiffJSON `json:"-"`
}

func (*StarknetErc1155Diff) UnmarshalJSON added in v0.22.1

func (r *StarknetErc1155Diff) UnmarshalJSON(data []byte) (err error)

type StarknetErc20Details added in v0.22.1

type StarknetErc20Details struct {
	// Address of the token's contract
	Address string `json:"address,required"`
	// token's decimals
	Decimals int64 `json:"decimals,required"`
	// token's name
	Name string `json:"name,required"`
	// token's symbol
	Symbol string `json:"symbol,required"`
	// URL of the asset's logo
	LogoURL string `json:"logo_url,nullable"`
	// Type of the asset (`ERC20`)
	Type StarknetErc20DetailsType `json:"type"`
	JSON starknetErc20DetailsJSON `json:"-"`
}

func (*StarknetErc20Details) UnmarshalJSON added in v0.22.1

func (r *StarknetErc20Details) UnmarshalJSON(data []byte) (err error)

type StarknetErc20DetailsType added in v0.22.1

type StarknetErc20DetailsType string

Type of the asset (`ERC20`)

const (
	StarknetErc20DetailsTypeErc20 StarknetErc20DetailsType = "ERC20"
)

func (StarknetErc20DetailsType) IsKnown added in v0.22.1

func (r StarknetErc20DetailsType) IsKnown() bool

type StarknetErc20Diff added in v0.22.1

type StarknetErc20Diff struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                `json:"summary,nullable"`
	JSON    starknetErc20DiffJSON `json:"-"`
}

func (*StarknetErc20Diff) UnmarshalJSON added in v0.22.1

func (r *StarknetErc20Diff) UnmarshalJSON(data []byte) (err error)

type StarknetErc721Details added in v0.22.1

type StarknetErc721Details struct {
	// Address of the token's contract
	Address string `json:"address,required"`
	// token's name
	Name string `json:"name,required"`
	// token's symbol
	Symbol string `json:"symbol,required"`
	// URL of the asset's logo
	LogoURL string `json:"logo_url,nullable"`
	// Type of the asset (`ERC721`)
	Type StarknetErc721DetailsType `json:"type"`
	JSON starknetErc721DetailsJSON `json:"-"`
}

func (*StarknetErc721Details) UnmarshalJSON added in v0.22.1

func (r *StarknetErc721Details) UnmarshalJSON(data []byte) (err error)

type StarknetErc721DetailsType added in v0.22.1

type StarknetErc721DetailsType string

Type of the asset (`ERC721`)

const (
	StarknetErc721DetailsTypeErc721 StarknetErc721DetailsType = "ERC721"
)

func (StarknetErc721DetailsType) IsKnown added in v0.22.1

func (r StarknetErc721DetailsType) IsKnown() bool

type StarknetErc721Diff added in v0.22.1

type StarknetErc721Diff struct {
	// Token ID of the transfer
	TokenID string `json:"token_id,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Summarized description of the transfer
	Summary string                 `json:"summary,nullable"`
	JSON    starknetErc721DiffJSON `json:"-"`
}

func (*StarknetErc721Diff) UnmarshalJSON added in v0.22.1

func (r *StarknetErc721Diff) UnmarshalJSON(data []byte) (err error)

type StarknetService added in v0.22.1

type StarknetService struct {
	Options     []option.RequestOption
	Transaction *StarknetTransactionService
}

StarknetService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewStarknetService method instead.

func NewStarknetService added in v0.22.1

func NewStarknetService(opts ...option.RequestOption) (r *StarknetService)

NewStarknetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type StarknetTransactionReportParams added in v0.34.0

type StarknetTransactionReportParams struct {
	Details param.Field[string]                                     `json:"details,required"`
	Event   param.Field[StarknetTransactionReportParamsEvent]       `json:"event,required"`
	Report  param.Field[StarknetTransactionReportParamsReportUnion] `json:"report,required"`
}

func (StarknetTransactionReportParams) MarshalJSON added in v0.34.0

func (r StarknetTransactionReportParams) MarshalJSON() (data []byte, err error)

type StarknetTransactionReportParamsEvent added in v0.34.0

type StarknetTransactionReportParamsEvent string
const (
	StarknetTransactionReportParamsEventShouldBeMalicious StarknetTransactionReportParamsEvent = "should_be_malicious"
	StarknetTransactionReportParamsEventShouldBeBenign    StarknetTransactionReportParamsEvent = "should_be_benign"
)

func (StarknetTransactionReportParamsEvent) IsKnown added in v0.34.0

type StarknetTransactionReportParamsReport added in v0.34.0

type StarknetTransactionReportParamsReport struct {
	ID     param.Field[string]                                    `json:"id"`
	Params param.Field[StarknetTransactionScanRequestParam]       `json:"params"`
	Type   param.Field[StarknetTransactionReportParamsReportType] `json:"type"`
}

func (StarknetTransactionReportParamsReport) MarshalJSON added in v0.34.0

func (r StarknetTransactionReportParamsReport) MarshalJSON() (data []byte, err error)

type StarknetTransactionReportParamsReportStarknetAppealRequestID added in v0.34.0

type StarknetTransactionReportParamsReportStarknetAppealRequestID struct {
	ID   param.Field[string]                                                           `json:"id,required"`
	Type param.Field[StarknetTransactionReportParamsReportStarknetAppealRequestIDType] `json:"type"`
}

func (StarknetTransactionReportParamsReportStarknetAppealRequestID) MarshalJSON added in v0.34.0

type StarknetTransactionReportParamsReportStarknetAppealRequestIDType added in v0.34.0

type StarknetTransactionReportParamsReportStarknetAppealRequestIDType string
const (
	StarknetTransactionReportParamsReportStarknetAppealRequestIDTypeRequestID StarknetTransactionReportParamsReportStarknetAppealRequestIDType = "request_id"
)

func (StarknetTransactionReportParamsReportStarknetAppealRequestIDType) IsKnown added in v0.34.0

type StarknetTransactionReportParamsReportStarknetAppealTransactionDataReport added in v0.34.0

type StarknetTransactionReportParamsReportStarknetAppealTransactionDataReport struct {
	Params param.Field[StarknetTransactionScanRequestParam]                                          `json:"params,required"`
	Type   param.Field[StarknetTransactionReportParamsReportStarknetAppealTransactionDataReportType] `json:"type"`
}

func (StarknetTransactionReportParamsReportStarknetAppealTransactionDataReport) MarshalJSON added in v0.34.0

type StarknetTransactionReportParamsReportStarknetAppealTransactionDataReportType added in v0.34.0

type StarknetTransactionReportParamsReportStarknetAppealTransactionDataReportType string
const (
	StarknetTransactionReportParamsReportStarknetAppealTransactionDataReportTypeParams StarknetTransactionReportParamsReportStarknetAppealTransactionDataReportType = "params"
)

func (StarknetTransactionReportParamsReportStarknetAppealTransactionDataReportType) IsKnown added in v0.34.0

type StarknetTransactionReportParamsReportType added in v0.34.0

type StarknetTransactionReportParamsReportType string
const (
	StarknetTransactionReportParamsReportTypeRequestID StarknetTransactionReportParamsReportType = "request_id"
	StarknetTransactionReportParamsReportTypeParams    StarknetTransactionReportParamsReportType = "params"
)

func (StarknetTransactionReportParamsReportType) IsKnown added in v0.34.0

type StarknetTransactionReportParamsReportUnion added in v0.34.0

type StarknetTransactionReportParamsReportUnion interface {
	// contains filtered or unexported methods
}

Satisfied by StarknetTransactionReportParamsReportStarknetAppealRequestID, StarknetTransactionReportParamsReportStarknetAppealTransactionDataReport, StarknetTransactionReportParamsReport.

type StarknetTransactionScanParams added in v0.22.1

type StarknetTransactionScanParams struct {
	StarknetTransactionScanRequest StarknetTransactionScanRequestParam `json:"StarknetTransactionScanRequest,required"`
}

func (StarknetTransactionScanParams) MarshalJSON added in v0.22.1

func (r StarknetTransactionScanParams) MarshalJSON() (data []byte, err error)

type StarknetTransactionScanRequestChain added in v0.29.0

type StarknetTransactionScanRequestChain string

A CAIP-2 or a Starknet network name or a Starknet network name

const (
	StarknetTransactionScanRequestChainMainnet            StarknetTransactionScanRequestChain = "mainnet"
	StarknetTransactionScanRequestChainSepolia            StarknetTransactionScanRequestChain = "sepolia"
	StarknetTransactionScanRequestChainSepoliaIntegration StarknetTransactionScanRequestChain = "sepolia_integration"
)

func (StarknetTransactionScanRequestChain) IsKnown added in v0.29.0

type StarknetTransactionScanRequestMetadataParam added in v0.29.0

type StarknetTransactionScanRequestMetadataParam struct {
	// Metadata for wallet requests
	Type param.Field[StarknetTransactionScanRequestMetadataType] `json:"type"`
	// URL of the dApp originating the transaction
	URL param.Field[string] `json:"url"`
}

Metadata

func (StarknetTransactionScanRequestMetadataParam) MarshalJSON added in v0.29.0

func (r StarknetTransactionScanRequestMetadataParam) MarshalJSON() (data []byte, err error)

type StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataParam added in v0.29.0

type StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataParam struct {
	// Metadata for in-app requests
	Type param.Field[StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataType] `json:"type"`
}

func (StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataParam) MarshalJSON added in v0.29.0

type StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataType added in v0.29.0

type StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataType string

Metadata for in-app requests

const (
	StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataTypeInApp StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataType = "in_app"
)

func (StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataType) IsKnown added in v0.29.0

type StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataParam added in v0.29.0

type StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataParam struct {
	// Metadata for wallet requests
	Type param.Field[StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataType] `json:"type,required"`
	// URL of the dApp originating the transaction
	URL param.Field[string] `json:"url,required"`
}

func (StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataParam) MarshalJSON added in v0.29.0

type StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataType added in v0.29.0

type StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataType string

Metadata for wallet requests

const (
	StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataTypeWallet StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataType = "wallet"
)

func (StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataType) IsKnown added in v0.29.0

type StarknetTransactionScanRequestMetadataType added in v0.29.0

type StarknetTransactionScanRequestMetadataType string

Metadata for wallet requests

const (
	StarknetTransactionScanRequestMetadataTypeWallet StarknetTransactionScanRequestMetadataType = "wallet"
	StarknetTransactionScanRequestMetadataTypeInApp  StarknetTransactionScanRequestMetadataType = "in_app"
)

func (StarknetTransactionScanRequestMetadataType) IsKnown added in v0.29.0

type StarknetTransactionScanRequestMetadataUnionParam added in v0.29.0

type StarknetTransactionScanRequestMetadataUnionParam interface {
	// contains filtered or unexported methods
}

Metadata

Satisfied by StarknetTransactionScanRequestMetadataStarknetWalletRequestMetadataParam, StarknetTransactionScanRequestMetadataStarknetInAppRequestMetadataParam, StarknetTransactionScanRequestMetadataParam.

type StarknetTransactionScanRequestOption added in v0.29.0

type StarknetTransactionScanRequestOption string
const (
	StarknetTransactionScanRequestOptionValidation StarknetTransactionScanRequestOption = "validation"
	StarknetTransactionScanRequestOptionSimulation StarknetTransactionScanRequestOption = "simulation"
)

func (StarknetTransactionScanRequestOption) IsKnown added in v0.29.0

type StarknetTransactionScanRequestParam added in v0.29.0

type StarknetTransactionScanRequestParam struct {
	AccountAddress param.Field[string] `json:"account_address,required"`
	// The chain name or chain ID
	Chain param.Field[StarknetTransactionScanRequestChain] `json:"chain,required"`
	// Metadata
	Metadata    param.Field[StarknetTransactionScanRequestMetadataUnionParam]    `json:"metadata,required"`
	Transaction param.Field[StarknetTransactionScanRequestTransactionUnionParam] `json:"transaction,required"`
	// Optional block number or tag context for the simulation
	BlockNumber param.Field[string] `json:"block_number"`
	// List of options to include in the response
	//
	// - `Options.validation`: Include Options.validation output in the response
	//
	// - `Options.simulation`: Include Options.simulation output in the response
	Options param.Field[[]StarknetTransactionScanRequestOption] `json:"options"`
}

func (StarknetTransactionScanRequestParam) MarshalJSON added in v0.29.0

func (r StarknetTransactionScanRequestParam) MarshalJSON() (data []byte, err error)

type StarknetTransactionScanRequestTransactionNonceDataAvailabilityMode added in v0.29.0

type StarknetTransactionScanRequestTransactionNonceDataAvailabilityMode int64

The nonce data availability mode.

const (
	StarknetTransactionScanRequestTransactionNonceDataAvailabilityMode0 StarknetTransactionScanRequestTransactionNonceDataAvailabilityMode = 0
)

func (StarknetTransactionScanRequestTransactionNonceDataAvailabilityMode) IsKnown added in v0.29.0

type StarknetTransactionScanRequestTransactionParam added in v0.29.0

type StarknetTransactionScanRequestTransactionParam struct {
	// The nonce of the transaction.
	Nonce param.Field[string] `json:"nonce,required"`
	// The version of the transaction.
	Version               param.Field[StarknetTransactionScanRequestTransactionVersion] `json:"version,required"`
	AccountDeploymentData param.Field[interface{}]                                      `json:"account_deployment_data"`
	Calldata              param.Field[interface{}]                                      `json:"calldata"`
	// The id of the chain to which the transaction is sent.
	ChainID param.Field[string] `json:"chain_id"`
	// The hash of the contract class.
	ClassHash           param.Field[string]      `json:"class_hash"`
	ConstructorCalldata param.Field[interface{}] `json:"constructor_calldata"`
	// The salt of the contract address.
	ContractAddressSalt param.Field[string] `json:"contract_address_salt"`
	// The maximum fee that the sender is willing to pay.
	MaxFee param.Field[string] `json:"max_fee"`
	// The nonce data availability mode.
	NonceDataAvailabilityMode param.Field[StarknetTransactionScanRequestTransactionNonceDataAvailabilityMode] `json:"nonce_data_availability_mode"`
	PaymasterData             param.Field[interface{}]                                                        `json:"paymaster_data"`
	// The address of the sender.
	SenderAddress param.Field[string] `json:"sender_address"`
}

func (StarknetTransactionScanRequestTransactionParam) MarshalJSON added in v0.29.0

func (r StarknetTransactionScanRequestTransactionParam) MarshalJSON() (data []byte, err error)

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaParam added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaParam struct {
	// The hash of the contract class.
	ClassHash param.Field[string] `json:"class_hash,required"`
	// The arguments that are passed to the constructor function.
	ConstructorCalldata param.Field[[]string] `json:"constructor_calldata,required"`
	// The salt of the contract address.
	ContractAddressSalt param.Field[string] `json:"contract_address_salt,required"`
	// The maximum fee that the sender is willing to pay.
	MaxFee param.Field[string] `json:"max_fee,required"`
	// The nonce of the transaction.
	Nonce param.Field[string] `json:"nonce,required"`
	// The version of the transaction.
	Version param.Field[StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaVersion] `json:"version,required"`
}

func (StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaParam) MarshalJSON added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaVersion added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaVersion int64

The version of the transaction.

const (
	StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaVersion1 StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaVersion = 1
)

func (StarknetTransactionScanRequestTransactionStarknetDeployAccountV1TransactionSchemaVersion) IsKnown added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaParam added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaParam struct {
	// The hash of the contract class.
	ClassHash param.Field[string] `json:"class_hash,required"`
	// The arguments that are passed to the constructor function.
	ConstructorCalldata param.Field[[]string] `json:"constructor_calldata,required"`
	// The salt of the contract address.
	ContractAddressSalt param.Field[string] `json:"contract_address_salt,required"`
	// The maximum fee that the sender is willing to pay.
	MaxFee param.Field[string] `json:"max_fee,required"`
	// The nonce of the transaction.
	Nonce param.Field[string] `json:"nonce,required"`
	// The version of the transaction.
	Version param.Field[StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaVersion] `json:"version,required"`
}

func (StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaParam) MarshalJSON added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaVersion added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaVersion int64

The version of the transaction.

const (
	StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaVersion3 StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaVersion = 3
)

func (StarknetTransactionScanRequestTransactionStarknetDeployAccountV3TransactionSchemaVersion) IsKnown added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaParam added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaParam struct {
	// The maximum fee that the sender is willing to pay.
	MaxFee param.Field[string] `json:"max_fee,required"`
	// The nonce of the transaction.
	Nonce param.Field[string] `json:"nonce,required"`
	// The address of the sender.
	SenderAddress param.Field[string] `json:"sender_address,required"`
	// The version of the transaction.
	Version param.Field[StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaVersion] `json:"version,required"`
	// The arguments that are passed to the validate and execute functions.
	Calldata param.Field[[]string] `json:"calldata"`
}

func (StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaParam) MarshalJSON added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaVersion added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaVersion int64

The version of the transaction.

const (
	StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaVersion1 StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaVersion = 1
)

func (StarknetTransactionScanRequestTransactionStarknetInvokeV1TransactionSchemaVersion) IsKnown added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaNonceDataAvailabilityMode added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaNonceDataAvailabilityMode int64

The nonce data availability mode.

const (
	StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaNonceDataAvailabilityMode0 StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaNonceDataAvailabilityMode = 0
)

func (StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaNonceDataAvailabilityMode) IsKnown added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaParam added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaParam struct {
	// The arguments that are passed to the validate and execute functions.
	Calldata param.Field[[]string] `json:"calldata,required"`
	// The id of the chain to which the transaction is sent.
	ChainID param.Field[string] `json:"chain_id,required"`
	// The nonce of the transaction.
	Nonce param.Field[string] `json:"nonce,required"`
	// The address of the sender.
	SenderAddress param.Field[string] `json:"sender_address,required"`
	// The version of the transaction.
	Version param.Field[StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaVersion] `json:"version,required"`
	// For future use. Currently this value is always empty.
	AccountDeploymentData param.Field[[]string] `json:"account_deployment_data"`
	// The nonce data availability mode.
	NonceDataAvailabilityMode param.Field[StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaNonceDataAvailabilityMode] `json:"nonce_data_availability_mode"`
	// For future use. Currently this value is always empty.
	PaymasterData param.Field[[]string] `json:"paymaster_data"`
}

func (StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaParam) MarshalJSON added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaVersion added in v0.29.0

type StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaVersion int64

The version of the transaction.

const (
	StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaVersion3 StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaVersion = 3
)

func (StarknetTransactionScanRequestTransactionStarknetInvokeV3TransactionSchemaVersion) IsKnown added in v0.29.0

type StarknetTransactionScanRequestTransactionVersion added in v0.29.0

type StarknetTransactionScanRequestTransactionVersion int64

The version of the transaction.

const (
	StarknetTransactionScanRequestTransactionVersion1 StarknetTransactionScanRequestTransactionVersion = 1
	StarknetTransactionScanRequestTransactionVersion3 StarknetTransactionScanRequestTransactionVersion = 3
)

func (StarknetTransactionScanRequestTransactionVersion) IsKnown added in v0.29.0

type StarknetTransactionScanResponse added in v0.22.1

type StarknetTransactionScanResponse struct {
	// Simulation result; Only present if simulation option is included in the request
	Simulation StarknetTransactionScanResponseSimulation `json:"simulation,nullable"`
	// Validation result; Only present if validation option is included in the request
	Validation StarknetTransactionScanResponseValidation `json:"validation,nullable"`
	JSON       starknetTransactionScanResponseJSON       `json:"-"`
}

func (*StarknetTransactionScanResponse) UnmarshalJSON added in v0.22.1

func (r *StarknetTransactionScanResponse) UnmarshalJSON(data []byte) (err error)

type StarknetTransactionScanResponseSimulation added in v0.22.1

type StarknetTransactionScanResponseSimulation struct {
	Status StarknetTransactionScanResponseSimulationStatus `json:"status,required"`
	// This field can have the runtime type of
	// [StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummary].
	AccountSummary interface{} `json:"account_summary"`
	// This field can have the runtime type of
	// [[]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAddressDetail].
	AddressDetails interface{} `json:"address_details"`
	// This field can have the runtime type of
	// [map[string][]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiff].
	AssetsDiffs interface{} `json:"assets_diffs"`
	// Optional block number or tag context for the simulation
	BlockNumber string `json:"block_number,nullable"`
	// Error message
	Error string `json:"error"`
	// This field can have the runtime type of
	// [map[string][]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposure].
	Exposures interface{}                                   `json:"exposures"`
	JSON      starknetTransactionScanResponseSimulationJSON `json:"-"`
	// contains filtered or unexported fields
}

Simulation result; Only present if simulation option is included in the request

func (StarknetTransactionScanResponseSimulation) AsUnion added in v0.22.1

AsUnion returns a StarknetTransactionScanResponseSimulationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchema, StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchema.

func (*StarknetTransactionScanResponseSimulation) UnmarshalJSON added in v0.22.1

func (r *StarknetTransactionScanResponseSimulation) UnmarshalJSON(data []byte) (err error)

type StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchema added in v0.22.1

type StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchema struct {
	// Error message
	Error  string                                                                       `json:"error,required"`
	Status StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchemaStatus `json:"status,required"`
	JSON   starknetTransactionScanResponseSimulationStarknetSimulationErrorSchemaJSON   `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchema) UnmarshalJSON added in v0.22.1

type StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchemaStatus added in v0.22.1

type StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchemaStatus string
const (
	StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchemaStatusError StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchemaStatus = "Error"
)

func (StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchemaStatus) IsKnown added in v0.22.1

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchema added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchema struct {
	// Summary of the actions and asset transfers that were made by the requested
	// account address
	AccountSummary StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummary `json:"account_summary,required"`
	Status         StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaStatus         `json:"status,required"`
	// Details of addresses involved in the transaction
	AddressDetails []StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAddressDetail `json:"address_details"`
	// Mapping between the address of an account to the assets diff during the
	// transaction
	AssetsDiffs map[string][]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiff `json:"assets_diffs"`
	// Optional block number or tag context for the simulation
	BlockNumber string `json:"block_number,nullable"`
	// Mapping between the address of an account to the exposure of the assets during
	// the transaction
	Exposures map[string][]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposure `json:"exposures"`
	JSON      starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaJSON                  `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchema) UnmarshalJSON added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummary added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummary struct {
	// Exposures made by the requested account address
	AccountExposures []StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposure `json:"account_exposures,required"`
	// Total USD diff for the requested account address
	TotalUsdDiff StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryTotalUsdDiff `json:"total_usd_diff,required"`
	// Assets diffs of the requested account address
	AccountAssetsDiffs []StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiff `json:"account_assets_diffs"`
	// Total USD exposure for each of the spender addresses during the transaction
	TotalUsdExposure map[string]float64                                                                                `json:"total_usd_exposure"`
	JSON             starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryJSON `json:"-"`
}

Summary of the actions and asset transfers that were made by the requested account address

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummary) UnmarshalJSON added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiff added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiff struct {
	// This field can have the runtime type of [StarknetErc20Details],
	// [StarknetErc721Details], [StarknetErc1155Details].
	Asset interface{} `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// This field can have the runtime type of [StarknetErc20Diff],
	// [StarknetErc721Diff], [StarknetErc1155Diff].
	In interface{} `json:"in"`
	// This field can have the runtime type of [StarknetErc20Diff],
	// [StarknetErc721Diff], [StarknetErc1155Diff].
	Out  interface{}                                                                                                        `json:"out"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiff) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc1155AssetDiff added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc1155AssetDiff struct {
	Asset StarknetErc1155Details `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StarknetErc1155Diff `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StarknetErc1155Diff                                                                                                                         `json:"out,nullable"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc1155AssetDiffJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc1155AssetDiff) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc20AssetDiff added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc20AssetDiff struct {
	Asset StarknetErc20Details `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StarknetErc20Diff `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StarknetErc20Diff                                                                                                                         `json:"out,nullable"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc20AssetDiffJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc20AssetDiff) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc721AssetDiff added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc721AssetDiff struct {
	Asset StarknetErc721Details `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StarknetErc721Diff `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StarknetErc721Diff                                                                                                                         `json:"out,nullable"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc721AssetDiffJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountAssetsDiffsStarknetErc721AssetDiff) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposure added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposure struct {
	// This field can have the runtime type of [StarknetErc20Details],
	// [StarknetErc721Details], [StarknetErc1155Details].
	Asset interface{} `json:"asset,required"`
	// This field can have the runtime type of
	// [map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20ExposureSpender],
	// [map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721ExposureSpender],
	// [map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155ExposureSpender].
	Spenders interface{}                                                                                                      `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposure) UnmarshalJSON added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155Exposure added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155Exposure struct {
	Asset StarknetErc1155Details `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155ExposureSpender `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155ExposureJSON               `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155Exposure) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155ExposureSpender added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155ExposureSpender struct {
	Exposure []StarknetErc1155Diff `json:"exposure,required"`
	// Whether `setApprovalForAll` was invoked
	IsApprovedForAll bool `json:"is_approved_for_all,required"`
	// Summarized description of the exposure
	Summary string                                                                                                                                          `json:"summary,nullable"`
	JSON    starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155ExposureSpenderJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc1155ExposureSpender) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20Exposure added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20Exposure struct {
	Asset StarknetErc20Details `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20ExposureSpender `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20ExposureJSON               `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20Exposure) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20ExposureSpender added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20ExposureSpender struct {
	// Approval value of the ERC20 token
	Approval string              `json:"approval,required"`
	Exposure []StarknetErc20Diff `json:"exposure,required"`
	// Expiration date of the approval
	Expiration time.Time `json:"expiration,nullable" format:"date-time"`
	// Summarized description of the exposure
	Summary string                                                                                                                                        `json:"summary,nullable"`
	JSON    starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20ExposureSpenderJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc20ExposureSpender) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721Exposure added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721Exposure struct {
	Asset StarknetErc721Details `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721ExposureSpender `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721ExposureJSON               `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721Exposure) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721ExposureSpender added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721ExposureSpender struct {
	Exposure []StarknetErc721Diff `json:"exposure,required"`
	// Whether `setApprovalForAll` was invoked
	IsApprovedForAll bool `json:"is_approved_for_all,required"`
	// Summarized description of the exposure
	Summary string                                                                                                                                         `json:"summary,nullable"`
	JSON    starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721ExposureSpenderJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryAccountExposuresStarknetErc721ExposureSpender) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryTotalUsdDiff added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryTotalUsdDiff struct {
	// Total incoming USD transfers
	In float64 `json:"in,required"`
	// Total outgoing USD transfers
	Out float64 `json:"out,required"`
	// Total USD transfers
	Total float64                                                                                                       `json:"total"`
	JSON  starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryTotalUsdDiffJSON `json:"-"`
}

Total USD diff for the requested account address

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAccountSummaryTotalUsdDiff) UnmarshalJSON added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAddressDetail added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAddressDetail struct {
	// Encoded public key of the account
	AccountAddress interface{} `json:"account_address,required"`
	// Description of the account
	Description string                                                                                           `json:"description,nullable"`
	JSON        starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAddressDetailJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAddressDetail) UnmarshalJSON added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiff added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiff struct {
	// This field can have the runtime type of [StarknetErc20Details],
	// [StarknetErc721Details], [StarknetErc1155Details].
	Asset interface{} `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// This field can have the runtime type of [StarknetErc20Diff],
	// [StarknetErc721Diff], [StarknetErc1155Diff].
	In interface{} `json:"in"`
	// This field can have the runtime type of [StarknetErc20Diff],
	// [StarknetErc721Diff], [StarknetErc1155Diff].
	Out  interface{}                                                                                   `json:"out"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiff) UnmarshalJSON added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc1155AssetDiff added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc1155AssetDiff struct {
	Asset StarknetErc1155Details `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StarknetErc1155Diff `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StarknetErc1155Diff                                                                                                    `json:"out,nullable"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc1155AssetDiffJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc1155AssetDiff) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc20AssetDiff added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc20AssetDiff struct {
	Asset StarknetErc20Details `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StarknetErc20Diff `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StarknetErc20Diff                                                                                                    `json:"out,nullable"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc20AssetDiffJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc20AssetDiff) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc721AssetDiff added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc721AssetDiff struct {
	Asset StarknetErc721Details `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StarknetErc721Diff `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StarknetErc721Diff                                                                                                    `json:"out,nullable"`
	JSON starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc721AssetDiffJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaAssetsDiffsStarknetErc721AssetDiff) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposure added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposure struct {
	// This field can have the runtime type of [StarknetErc20Details],
	// [StarknetErc721Details], [StarknetErc1155Details].
	Asset interface{} `json:"asset,required"`
	// This field can have the runtime type of
	// [map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20ExposureSpender],
	// [map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721ExposureSpender],
	// [map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155ExposureSpender].
	Spenders interface{}                                                                                 `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposure) UnmarshalJSON added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155Exposure added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155Exposure struct {
	Asset StarknetErc1155Details `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155ExposureSpender `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155ExposureJSON               `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155Exposure) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155ExposureSpender added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155ExposureSpender struct {
	Exposure []StarknetErc1155Diff `json:"exposure,required"`
	// Whether `setApprovalForAll` was invoked
	IsApprovedForAll bool `json:"is_approved_for_all,required"`
	// Summarized description of the exposure
	Summary string                                                                                                                     `json:"summary,nullable"`
	JSON    starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155ExposureSpenderJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc1155ExposureSpender) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20Exposure added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20Exposure struct {
	Asset StarknetErc20Details `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20ExposureSpender `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20ExposureJSON               `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20Exposure) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20ExposureSpender added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20ExposureSpender struct {
	// Approval value of the ERC20 token
	Approval string              `json:"approval,required"`
	Exposure []StarknetErc20Diff `json:"exposure,required"`
	// Expiration date of the approval
	Expiration time.Time `json:"expiration,nullable" format:"date-time"`
	// Summarized description of the exposure
	Summary string                                                                                                                   `json:"summary,nullable"`
	JSON    starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20ExposureSpenderJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc20ExposureSpender) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721Exposure added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721Exposure struct {
	Asset StarknetErc721Details `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721ExposureSpender `json:"spenders"`
	JSON     starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721ExposureJSON               `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721Exposure) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721ExposureSpender added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721ExposureSpender struct {
	Exposure []StarknetErc721Diff `json:"exposure,required"`
	// Whether `setApprovalForAll` was invoked
	IsApprovedForAll bool `json:"is_approved_for_all,required"`
	// Summarized description of the exposure
	Summary string                                                                                                                    `json:"summary,nullable"`
	JSON    starknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721ExposureSpenderJSON `json:"-"`
}

func (*StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaExposuresStarknetErc721ExposureSpender) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaStatus added in v0.26.0

type StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaStatus string
const (
	StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaStatusSuccess StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaStatus = "Success"
)

func (StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchemaStatus) IsKnown added in v0.26.0

type StarknetTransactionScanResponseSimulationStatus added in v0.22.1

type StarknetTransactionScanResponseSimulationStatus string
const (
	StarknetTransactionScanResponseSimulationStatusSuccess StarknetTransactionScanResponseSimulationStatus = "Success"
	StarknetTransactionScanResponseSimulationStatusError   StarknetTransactionScanResponseSimulationStatus = "Error"
)

func (StarknetTransactionScanResponseSimulationStatus) IsKnown added in v0.22.1

type StarknetTransactionScanResponseSimulationUnion added in v0.22.1

type StarknetTransactionScanResponseSimulationUnion interface {
	// contains filtered or unexported methods
}

Simulation result; Only present if simulation option is included in the request

Union satisfied by StarknetTransactionScanResponseSimulationStarknetStarknetSimulationResultSchema or StarknetTransactionScanResponseSimulationStarknetSimulationErrorSchema.

type StarknetTransactionScanResponseValidation added in v0.22.1

type StarknetTransactionScanResponseValidation struct {
	Status StarknetTransactionScanResponseValidationStatus `json:"status,required"`
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification"`
	// A textual description about the validation result
	Description string `json:"description"`
	// Error message
	Error string `json:"error"`
	// This field can have the runtime type of
	// [[]StarknetTransactionScanResponseValidationStarknetValidationResultFeature].
	Features interface{} `json:"features"`
	// A textual description about the reasons the transaction was flagged with
	// result_type
	Reason string `json:"reason"`
	// Verdict of the validation
	ResultType StarknetTransactionScanResponseValidationResultType `json:"result_type"`
	JSON       starknetTransactionScanResponseValidationJSON       `json:"-"`
	// contains filtered or unexported fields
}

Validation result; Only present if validation option is included in the request

func (StarknetTransactionScanResponseValidation) AsUnion added in v0.22.1

AsUnion returns a StarknetTransactionScanResponseValidationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are StarknetTransactionScanResponseValidationStarknetValidationResult, StarknetTransactionScanResponseValidationStarknetValidationErrorSchema.

func (*StarknetTransactionScanResponseValidation) UnmarshalJSON added in v0.22.1

func (r *StarknetTransactionScanResponseValidation) UnmarshalJSON(data []byte) (err error)

type StarknetTransactionScanResponseValidationResultType added in v0.22.1

type StarknetTransactionScanResponseValidationResultType string

Verdict of the validation

const (
	StarknetTransactionScanResponseValidationResultTypeBenign    StarknetTransactionScanResponseValidationResultType = "Benign"
	StarknetTransactionScanResponseValidationResultTypeWarning   StarknetTransactionScanResponseValidationResultType = "Warning"
	StarknetTransactionScanResponseValidationResultTypeMalicious StarknetTransactionScanResponseValidationResultType = "Malicious"
)

func (StarknetTransactionScanResponseValidationResultType) IsKnown added in v0.22.1

type StarknetTransactionScanResponseValidationStarknetValidationErrorSchema added in v0.22.1

type StarknetTransactionScanResponseValidationStarknetValidationErrorSchema struct {
	// Error message
	Error  string                                                                       `json:"error,required"`
	Status StarknetTransactionScanResponseValidationStarknetValidationErrorSchemaStatus `json:"status,required"`
	JSON   starknetTransactionScanResponseValidationStarknetValidationErrorSchemaJSON   `json:"-"`
}

func (*StarknetTransactionScanResponseValidationStarknetValidationErrorSchema) UnmarshalJSON added in v0.22.1

type StarknetTransactionScanResponseValidationStarknetValidationErrorSchemaStatus added in v0.22.1

type StarknetTransactionScanResponseValidationStarknetValidationErrorSchemaStatus string
const (
	StarknetTransactionScanResponseValidationStarknetValidationErrorSchemaStatusError StarknetTransactionScanResponseValidationStarknetValidationErrorSchemaStatus = "Error"
)

func (StarknetTransactionScanResponseValidationStarknetValidationErrorSchemaStatus) IsKnown added in v0.22.1

type StarknetTransactionScanResponseValidationStarknetValidationResult added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResult struct {
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification,required"`
	// A textual description about the validation result
	Description string                                                                     `json:"description,required"`
	Features    []StarknetTransactionScanResponseValidationStarknetValidationResultFeature `json:"features,required"`
	// A textual description about the reasons the transaction was flagged with
	// result_type
	Reason string `json:"reason,required"`
	// Verdict of the validation
	ResultType StarknetTransactionScanResponseValidationStarknetValidationResultResultType `json:"result_type,required"`
	Status     StarknetTransactionScanResponseValidationStarknetValidationResultStatus     `json:"status,required"`
	JSON       starknetTransactionScanResponseValidationStarknetValidationResultJSON       `json:"-"`
}

func (*StarknetTransactionScanResponseValidationStarknetValidationResult) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultFeature added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultFeature struct {
	// Address the feature refers to
	Address string `json:"address,required"`
	// Textual description
	Description string `json:"description,required"`
	FeatureID   string `json:"feature_id,required"`
	// Feature Classification
	Type StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType `json:"type,required"`
	JSON starknetTransactionScanResponseValidationStarknetValidationResultFeatureJSON  `json:"-"`
}

func (*StarknetTransactionScanResponseValidationStarknetValidationResultFeature) UnmarshalJSON added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType string

Feature Classification

const (
	StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesTypeBenign    StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType = "Benign"
	StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesTypeWarning   StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType = "Warning"
	StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesTypeMalicious StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType = "Malicious"
	StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesTypeInfo      StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType = "Info"
)

func (StarknetTransactionScanResponseValidationStarknetValidationResultFeaturesType) IsKnown added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultResultType added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultResultType string

Verdict of the validation

const (
	StarknetTransactionScanResponseValidationStarknetValidationResultResultTypeBenign    StarknetTransactionScanResponseValidationStarknetValidationResultResultType = "Benign"
	StarknetTransactionScanResponseValidationStarknetValidationResultResultTypeWarning   StarknetTransactionScanResponseValidationStarknetValidationResultResultType = "Warning"
	StarknetTransactionScanResponseValidationStarknetValidationResultResultTypeMalicious StarknetTransactionScanResponseValidationStarknetValidationResultResultType = "Malicious"
)

func (StarknetTransactionScanResponseValidationStarknetValidationResultResultType) IsKnown added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultStatus added in v0.29.0

type StarknetTransactionScanResponseValidationStarknetValidationResultStatus string
const (
	StarknetTransactionScanResponseValidationStarknetValidationResultStatusSuccess StarknetTransactionScanResponseValidationStarknetValidationResultStatus = "Success"
)

func (StarknetTransactionScanResponseValidationStarknetValidationResultStatus) IsKnown added in v0.29.0

type StarknetTransactionScanResponseValidationStatus added in v0.22.1

type StarknetTransactionScanResponseValidationStatus string
const (
	StarknetTransactionScanResponseValidationStatusSuccess StarknetTransactionScanResponseValidationStatus = "Success"
	StarknetTransactionScanResponseValidationStatusError   StarknetTransactionScanResponseValidationStatus = "Error"
)

func (StarknetTransactionScanResponseValidationStatus) IsKnown added in v0.22.1

type StarknetTransactionScanResponseValidationUnion added in v0.22.1

type StarknetTransactionScanResponseValidationUnion interface {
	// contains filtered or unexported methods
}

Validation result; Only present if validation option is included in the request

Union satisfied by StarknetTransactionScanResponseValidationStarknetValidationResult or StarknetTransactionScanResponseValidationStarknetValidationErrorSchema.

type StarknetTransactionService added in v0.22.1

type StarknetTransactionService struct {
	Options []option.RequestOption
}

StarknetTransactionService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewStarknetTransactionService method instead.

func NewStarknetTransactionService added in v0.22.1

func NewStarknetTransactionService(opts ...option.RequestOption) (r *StarknetTransactionService)

NewStarknetTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*StarknetTransactionService) Report added in v0.34.0

Report Transaction

func (*StarknetTransactionService) Scan added in v0.22.1

Scan Transactions

type StellarAssetContractDetails added in v0.29.0

type StellarAssetContractDetails struct {
	// Address of the asset's contract
	Address string `json:"address,required"`
	// Asset code
	Name string `json:"name,required"`
	// Asset symbol
	Symbol string `json:"symbol,required"`
	// Type of the asset (`CONTRACT`)
	Type StellarAssetContractDetailsType `json:"type"`
	JSON stellarAssetContractDetailsJSON `json:"-"`
}

func (*StellarAssetContractDetails) UnmarshalJSON added in v0.29.0

func (r *StellarAssetContractDetails) UnmarshalJSON(data []byte) (err error)

type StellarAssetContractDetailsType added in v0.29.0

type StellarAssetContractDetailsType string

Type of the asset (`CONTRACT`)

const (
	StellarAssetContractDetailsTypeContract StellarAssetContractDetailsType = "CONTRACT"
)

func (StellarAssetContractDetailsType) IsKnown added in v0.29.0

type StellarAssetTransferDetails added in v0.29.0

type StellarAssetTransferDetails struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                          `json:"summary,nullable"`
	JSON    stellarAssetTransferDetailsJSON `json:"-"`
}

func (*StellarAssetTransferDetails) UnmarshalJSON added in v0.29.0

func (r *StellarAssetTransferDetails) UnmarshalJSON(data []byte) (err error)

type StellarLegacyAssetDetails added in v0.29.0

type StellarLegacyAssetDetails struct {
	// Asset code
	Code string `json:"code,required"`
	// Asset issuer address
	Issuer string `json:"issuer,required"`
	// Organization name
	OrgName string `json:"org_name,required"`
	// Organization URL
	OrgURL string `json:"org_url,required"`
	// Type of the asset (`ASSET`)
	Type StellarLegacyAssetDetailsType `json:"type"`
	JSON stellarLegacyAssetDetailsJSON `json:"-"`
}

func (*StellarLegacyAssetDetails) UnmarshalJSON added in v0.29.0

func (r *StellarLegacyAssetDetails) UnmarshalJSON(data []byte) (err error)

type StellarLegacyAssetDetailsType added in v0.29.0

type StellarLegacyAssetDetailsType string

Type of the asset (`ASSET`)

const (
	StellarLegacyAssetDetailsTypeAsset StellarLegacyAssetDetailsType = "ASSET"
)

func (StellarLegacyAssetDetailsType) IsKnown added in v0.29.0

func (r StellarLegacyAssetDetailsType) IsKnown() bool

type StellarNativeAssetDetails added in v0.29.0

type StellarNativeAssetDetails struct {
	// Asset code
	Code StellarNativeAssetDetailsCode `json:"code"`
	// Type of the asset (`NATIVE`)
	Type StellarNativeAssetDetailsType `json:"type"`
	JSON stellarNativeAssetDetailsJSON `json:"-"`
}

func (*StellarNativeAssetDetails) UnmarshalJSON added in v0.29.0

func (r *StellarNativeAssetDetails) UnmarshalJSON(data []byte) (err error)

type StellarNativeAssetDetailsCode added in v0.29.0

type StellarNativeAssetDetailsCode string

Asset code

const (
	StellarNativeAssetDetailsCodeXlm StellarNativeAssetDetailsCode = "XLM"
)

func (StellarNativeAssetDetailsCode) IsKnown added in v0.29.0

func (r StellarNativeAssetDetailsCode) IsKnown() bool

type StellarNativeAssetDetailsType added in v0.29.0

type StellarNativeAssetDetailsType string

Type of the asset (`NATIVE`)

const (
	StellarNativeAssetDetailsTypeNative StellarNativeAssetDetailsType = "NATIVE"
)

func (StellarNativeAssetDetailsType) IsKnown added in v0.29.0

func (r StellarNativeAssetDetailsType) IsKnown() bool

type StellarService added in v0.11.0

type StellarService struct {
	Options     []option.RequestOption
	Transaction *StellarTransactionService
}

StellarService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewStellarService method instead.

func NewStellarService added in v0.11.0

func NewStellarService(opts ...option.RequestOption) (r *StellarService)

NewStellarService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type StellarSingleAssetExposure added in v0.29.0

type StellarSingleAssetExposure struct {
	// Approval value of the ERC20 token
	Approval string                               `json:"approval,required"`
	Exposure []StellarSingleAssetExposureExposure `json:"exposure,required"`
	// Expiration date of the approval
	Expiration time.Time `json:"expiration,nullable" format:"date-time"`
	// Summarized description of the exposure
	Summary string                         `json:"summary,nullable"`
	JSON    stellarSingleAssetExposureJSON `json:"-"`
}

func (*StellarSingleAssetExposure) UnmarshalJSON added in v0.29.0

func (r *StellarSingleAssetExposure) UnmarshalJSON(data []byte) (err error)

type StellarSingleAssetExposureExposure added in v0.29.0

type StellarSingleAssetExposureExposure struct {
	// Raw value of the transfer
	RawValue int64 `json:"raw_value,required"`
	// USD price of the asset
	UsdPrice string `json:"usd_price,required"`
	// Value of the transfer
	Value string `json:"value,required"`
	// Summarized description of the transfer
	Summary string                                 `json:"summary,nullable"`
	JSON    stellarSingleAssetExposureExposureJSON `json:"-"`
}

func (*StellarSingleAssetExposureExposure) UnmarshalJSON added in v0.29.0

func (r *StellarSingleAssetExposureExposure) UnmarshalJSON(data []byte) (err error)

type StellarTransactionReportParams added in v0.34.0

type StellarTransactionReportParams struct {
	Details param.Field[string]                                    `json:"details,required"`
	Event   param.Field[StellarTransactionReportParamsEvent]       `json:"event,required"`
	Report  param.Field[StellarTransactionReportParamsReportUnion] `json:"report,required"`
}

func (StellarTransactionReportParams) MarshalJSON added in v0.34.0

func (r StellarTransactionReportParams) MarshalJSON() (data []byte, err error)

type StellarTransactionReportParamsEvent added in v0.34.0

type StellarTransactionReportParamsEvent string
const (
	StellarTransactionReportParamsEventShouldBeMalicious     StellarTransactionReportParamsEvent = "should_be_malicious"
	StellarTransactionReportParamsEventShouldBeBenign        StellarTransactionReportParamsEvent = "should_be_benign"
	StellarTransactionReportParamsEventWrongSimulationResult StellarTransactionReportParamsEvent = "wrong_simulation_result"
)

func (StellarTransactionReportParamsEvent) IsKnown added in v0.34.0

type StellarTransactionReportParamsReport added in v0.34.0

type StellarTransactionReportParamsReport struct {
	ID     param.Field[string]                                   `json:"id"`
	Params param.Field[StellarTransactionScanRequestParam]       `json:"params"`
	Type   param.Field[StellarTransactionReportParamsReportType] `json:"type"`
}

func (StellarTransactionReportParamsReport) MarshalJSON added in v0.34.0

func (r StellarTransactionReportParamsReport) MarshalJSON() (data []byte, err error)

type StellarTransactionReportParamsReportStellarAppealRequestID added in v0.34.0

type StellarTransactionReportParamsReportStellarAppealRequestID struct {
	ID   param.Field[string]                                                         `json:"id,required"`
	Type param.Field[StellarTransactionReportParamsReportStellarAppealRequestIDType] `json:"type"`
}

func (StellarTransactionReportParamsReportStellarAppealRequestID) MarshalJSON added in v0.34.0

type StellarTransactionReportParamsReportStellarAppealRequestIDType added in v0.34.0

type StellarTransactionReportParamsReportStellarAppealRequestIDType string
const (
	StellarTransactionReportParamsReportStellarAppealRequestIDTypeRequestID StellarTransactionReportParamsReportStellarAppealRequestIDType = "request_id"
)

func (StellarTransactionReportParamsReportStellarAppealRequestIDType) IsKnown added in v0.34.0

type StellarTransactionReportParamsReportStellarAppealTransactionDataReport added in v0.34.0

type StellarTransactionReportParamsReportStellarAppealTransactionDataReport struct {
	Params param.Field[StellarTransactionScanRequestParam]                                         `json:"params,required"`
	Type   param.Field[StellarTransactionReportParamsReportStellarAppealTransactionDataReportType] `json:"type"`
}

func (StellarTransactionReportParamsReportStellarAppealTransactionDataReport) MarshalJSON added in v0.34.0

type StellarTransactionReportParamsReportStellarAppealTransactionDataReportType added in v0.34.0

type StellarTransactionReportParamsReportStellarAppealTransactionDataReportType string
const (
	StellarTransactionReportParamsReportStellarAppealTransactionDataReportTypeParams StellarTransactionReportParamsReportStellarAppealTransactionDataReportType = "params"
)

func (StellarTransactionReportParamsReportStellarAppealTransactionDataReportType) IsKnown added in v0.34.0

type StellarTransactionReportParamsReportType added in v0.34.0

type StellarTransactionReportParamsReportType string
const (
	StellarTransactionReportParamsReportTypeRequestID StellarTransactionReportParamsReportType = "request_id"
	StellarTransactionReportParamsReportTypeParams    StellarTransactionReportParamsReportType = "params"
)

func (StellarTransactionReportParamsReportType) IsKnown added in v0.34.0

type StellarTransactionReportParamsReportUnion added in v0.34.0

type StellarTransactionReportParamsReportUnion interface {
	// contains filtered or unexported methods
}

Satisfied by StellarTransactionReportParamsReportStellarAppealRequestID, StellarTransactionReportParamsReportStellarAppealTransactionDataReport, StellarTransactionReportParamsReport.

type StellarTransactionScanParams added in v0.11.0

type StellarTransactionScanParams struct {
	StellarTransactionScanRequest StellarTransactionScanRequestParam `json:"StellarTransactionScanRequest,required"`
}

func (StellarTransactionScanParams) MarshalJSON added in v0.11.0

func (r StellarTransactionScanParams) MarshalJSON() (data []byte, err error)

type StellarTransactionScanRequestChain added in v0.11.0

type StellarTransactionScanRequestChain string

A CAIP-2 chain ID or a Stellar network name

const (
	StellarTransactionScanRequestChainPubnet    StellarTransactionScanRequestChain = "pubnet"
	StellarTransactionScanRequestChainFuturenet StellarTransactionScanRequestChain = "futurenet"
	StellarTransactionScanRequestChainTestnet   StellarTransactionScanRequestChain = "testnet"
)

func (StellarTransactionScanRequestChain) IsKnown added in v0.11.0

type StellarTransactionScanRequestMetadataParam added in v0.11.0

type StellarTransactionScanRequestMetadataParam struct {
	// Metadata for wallet requests
	Type param.Field[StellarTransactionScanRequestMetadataType] `json:"type"`
	// URL of the dApp originating the transaction
	URL param.Field[string] `json:"url"`
}

Metadata

func (StellarTransactionScanRequestMetadataParam) MarshalJSON added in v0.11.0

func (r StellarTransactionScanRequestMetadataParam) MarshalJSON() (data []byte, err error)

type StellarTransactionScanRequestMetadataStellarInAppRequestMetadataParam added in v0.11.0

type StellarTransactionScanRequestMetadataStellarInAppRequestMetadataParam struct {
	// Metadata for in-app requests
	Type param.Field[StellarTransactionScanRequestMetadataStellarInAppRequestMetadataType] `json:"type"`
}

func (StellarTransactionScanRequestMetadataStellarInAppRequestMetadataParam) MarshalJSON added in v0.11.0

type StellarTransactionScanRequestMetadataStellarInAppRequestMetadataType added in v0.11.0

type StellarTransactionScanRequestMetadataStellarInAppRequestMetadataType string

Metadata for in-app requests

const (
	StellarTransactionScanRequestMetadataStellarInAppRequestMetadataTypeInApp StellarTransactionScanRequestMetadataStellarInAppRequestMetadataType = "in_app"
)

func (StellarTransactionScanRequestMetadataStellarInAppRequestMetadataType) IsKnown added in v0.11.0

type StellarTransactionScanRequestMetadataStellarWalletRequestMetadataParam added in v0.11.0

type StellarTransactionScanRequestMetadataStellarWalletRequestMetadataParam struct {
	// Metadata for wallet requests
	Type param.Field[StellarTransactionScanRequestMetadataStellarWalletRequestMetadataType] `json:"type,required"`
	// URL of the dApp originating the transaction
	URL param.Field[string] `json:"url,required"`
}

func (StellarTransactionScanRequestMetadataStellarWalletRequestMetadataParam) MarshalJSON added in v0.11.0

type StellarTransactionScanRequestMetadataStellarWalletRequestMetadataType added in v0.11.0

type StellarTransactionScanRequestMetadataStellarWalletRequestMetadataType string

Metadata for wallet requests

const (
	StellarTransactionScanRequestMetadataStellarWalletRequestMetadataTypeWallet StellarTransactionScanRequestMetadataStellarWalletRequestMetadataType = "wallet"
)

func (StellarTransactionScanRequestMetadataStellarWalletRequestMetadataType) IsKnown added in v0.11.0

type StellarTransactionScanRequestMetadataType added in v0.11.0

type StellarTransactionScanRequestMetadataType string

Metadata for wallet requests

const (
	StellarTransactionScanRequestMetadataTypeWallet StellarTransactionScanRequestMetadataType = "wallet"
	StellarTransactionScanRequestMetadataTypeInApp  StellarTransactionScanRequestMetadataType = "in_app"
)

func (StellarTransactionScanRequestMetadataType) IsKnown added in v0.11.0

type StellarTransactionScanRequestMetadataUnionParam added in v0.11.0

type StellarTransactionScanRequestMetadataUnionParam interface {
	// contains filtered or unexported methods
}

Metadata

Satisfied by StellarTransactionScanRequestMetadataStellarWalletRequestMetadataParam, StellarTransactionScanRequestMetadataStellarInAppRequestMetadataParam, StellarTransactionScanRequestMetadataParam.

type StellarTransactionScanRequestOption added in v0.11.0

type StellarTransactionScanRequestOption string
const (
	StellarTransactionScanRequestOptionValidation StellarTransactionScanRequestOption = "validation"
	StellarTransactionScanRequestOptionSimulation StellarTransactionScanRequestOption = "simulation"
)

func (StellarTransactionScanRequestOption) IsKnown added in v0.11.0

type StellarTransactionScanRequestParam added in v0.11.0

type StellarTransactionScanRequestParam struct {
	AccountAddress param.Field[string] `json:"account_address,required"`
	// A CAIP-2 chain ID or a Stellar network name
	Chain param.Field[StellarTransactionScanRequestChain] `json:"chain,required"`
	// Metadata
	Metadata    param.Field[StellarTransactionScanRequestMetadataUnionParam] `json:"metadata,required"`
	Transaction param.Field[string]                                          `json:"transaction,required"`
	// List of options to include in the response
	//
	// - `Options.validation`: Include Options.validation output in the response
	//
	// - `Options.simulation`: Include Options.simulation output in the response
	Options param.Field[[]StellarTransactionScanRequestOption] `json:"options"`
}

func (StellarTransactionScanRequestParam) MarshalJSON added in v0.11.0

func (r StellarTransactionScanRequestParam) MarshalJSON() (data []byte, err error)

type StellarTransactionScanResponse added in v0.11.0

type StellarTransactionScanResponse struct {
	// Simulation result; Only present if simulation option is included in the request
	Simulation StellarTransactionScanResponseSimulation `json:"simulation,nullable"`
	// Validation result; Only present if validation option is included in the request
	Validation StellarTransactionScanResponseValidation `json:"validation,nullable"`
	JSON       stellarTransactionScanResponseJSON       `json:"-"`
}

func (*StellarTransactionScanResponse) UnmarshalJSON added in v0.11.0

func (r *StellarTransactionScanResponse) UnmarshalJSON(data []byte) (err error)

type StellarTransactionScanResponseSimulation added in v0.11.0

type StellarTransactionScanResponseSimulation struct {
	Status StellarTransactionScanResponseSimulationStatus `json:"status,required"`
	// This field can have the runtime type of
	// [StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummary].
	AccountSummary interface{} `json:"account_summary"`
	// This field can have the runtime type of
	// [[]StellarTransactionScanResponseSimulationStellarSimulationResultAddressDetail].
	AddressDetails interface{} `json:"address_details"`
	// This field can have the runtime type of
	// [map[string][]StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiff].
	AssetsDiffs interface{} `json:"assets_diffs"`
	// This field can have the runtime type of
	// [map[string][]StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiff].
	AssetsOwnershipDiff interface{} `json:"assets_ownership_diff"`
	// Error message
	Error string `json:"error"`
	// This field can have the runtime type of
	// [map[string][]StellarTransactionScanResponseSimulationStellarSimulationResultExposure].
	Exposures interface{}                                  `json:"exposures"`
	JSON      stellarTransactionScanResponseSimulationJSON `json:"-"`
	// contains filtered or unexported fields
}

Simulation result; Only present if simulation option is included in the request

func (StellarTransactionScanResponseSimulation) AsUnion added in v0.11.0

AsUnion returns a StellarTransactionScanResponseSimulationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are StellarTransactionScanResponseSimulationStellarSimulationResult, StellarTransactionScanResponseSimulationStellarSimulationErrorSchema.

func (*StellarTransactionScanResponseSimulation) UnmarshalJSON added in v0.11.0

func (r *StellarTransactionScanResponseSimulation) UnmarshalJSON(data []byte) (err error)

type StellarTransactionScanResponseSimulationStatus added in v0.11.0

type StellarTransactionScanResponseSimulationStatus string
const (
	StellarTransactionScanResponseSimulationStatusSuccess StellarTransactionScanResponseSimulationStatus = "Success"
	StellarTransactionScanResponseSimulationStatusError   StellarTransactionScanResponseSimulationStatus = "Error"
)

func (StellarTransactionScanResponseSimulationStatus) IsKnown added in v0.11.0

type StellarTransactionScanResponseSimulationStellarSimulationErrorSchema added in v0.11.0

type StellarTransactionScanResponseSimulationStellarSimulationErrorSchema struct {
	// Error message
	Error  string                                                                     `json:"error,required"`
	Status StellarTransactionScanResponseSimulationStellarSimulationErrorSchemaStatus `json:"status,required"`
	JSON   stellarTransactionScanResponseSimulationStellarSimulationErrorSchemaJSON   `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationErrorSchema) UnmarshalJSON added in v0.11.0

type StellarTransactionScanResponseSimulationStellarSimulationErrorSchemaStatus added in v0.11.0

type StellarTransactionScanResponseSimulationStellarSimulationErrorSchemaStatus string
const (
	StellarTransactionScanResponseSimulationStellarSimulationErrorSchemaStatusError StellarTransactionScanResponseSimulationStellarSimulationErrorSchemaStatus = "Error"
)

func (StellarTransactionScanResponseSimulationStellarSimulationErrorSchemaStatus) IsKnown added in v0.11.0

type StellarTransactionScanResponseSimulationStellarSimulationResult added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResult struct {
	// Summary of the actions and asset transfers that were made by the requested
	// account address
	AccountSummary StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummary `json:"account_summary,required"`
	// Ownership diffs of the account addresses
	AssetsOwnershipDiff map[string][]StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiff `json:"assets_ownership_diff,required"`
	Status              StellarTransactionScanResponseSimulationStellarSimulationResultStatus                           `json:"status,required"`
	// Details of addresses involved in the transaction
	AddressDetails []StellarTransactionScanResponseSimulationStellarSimulationResultAddressDetail `json:"address_details"`
	// Mapping between the address of an account to the assets diff during the
	// transaction
	AssetsDiffs map[string][]StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiff `json:"assets_diffs"`
	// Mapping between the address of an account to the exposure of the assets during
	// the transaction
	Exposures map[string][]StellarTransactionScanResponseSimulationStellarSimulationResultExposure `json:"exposures"`
	JSON      stellarTransactionScanResponseSimulationStellarSimulationResultJSON                  `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResult) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummary added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummary struct {
	// Exposures made by the requested account address
	AccountExposures []StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposure `json:"account_exposures,required"`
	// Ownership diffs of the requested account address
	AccountOwnershipsDiff []StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiff `json:"account_ownerships_diff,required"`
	// Total USD diff for the requested account address
	TotalUsdDiff StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryTotalUsdDiff `json:"total_usd_diff,required"`
	// Assets diffs of the requested account address
	AccountAssetsDiffs []StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiff `json:"account_assets_diffs"`
	// Total USD exposure for each of the spender addresses during the transaction
	TotalUsdExposure map[string]float64                                                                `json:"total_usd_exposure"`
	JSON             stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryJSON `json:"-"`
}

Summary of the actions and asset transfers that were made by the requested account address

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummary) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiff struct {
	// This field can have the runtime type of [StellarLegacyAssetDetails],
	// [StellarNativeAssetDetails], [StellarAssetContractDetails].
	Asset interface{} `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                                        `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarContractAssetDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarContractAssetDiff struct {
	Asset StellarAssetContractDetails `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                                                                 `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarContractAssetDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarContractAssetDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarLegacyAssetDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarLegacyAssetDiff struct {
	Asset StellarLegacyAssetDetails `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                                                               `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarLegacyAssetDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarLegacyAssetDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarNativeAssetDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarNativeAssetDiff struct {
	Asset StellarNativeAssetDetails `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                                                               `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarNativeAssetDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountAssetsDiffsStellarNativeAssetDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposure added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposure struct {
	// This field can have the runtime type of [StellarLegacyAssetDetails],
	// [StellarNativeAssetDetails].
	Asset interface{} `json:"asset,required"`
	// This field can have the runtime type of [map[string]StellarSingleAssetExposure].
	Spenders interface{}                                                                                      `json:"spenders"`
	JSON     stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposure) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarLegacyAssetExposure added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarLegacyAssetExposure struct {
	Asset StellarLegacyAssetDetails `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StellarSingleAssetExposure                                                                                       `json:"spenders"`
	JSON     stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarLegacyAssetExposureJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarLegacyAssetExposure) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarNativeAssetExposure added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarNativeAssetExposure struct {
	Asset StellarNativeAssetDetails `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StellarSingleAssetExposure                                                                                       `json:"spenders"`
	JSON     stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarNativeAssetExposureJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountExposuresStellarNativeAssetExposure) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiff struct {
	// List of public keys that can sign on behalf of the account post-transaction
	PostSigners []string `json:"post_signers,required"`
	// List of public keys that can sign on behalf of the account pre-transaction
	PreSigners []string                                                                                               `json:"pre_signers,required"`
	Type       StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiffType `json:"type"`
	JSON       stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiffType added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiffType string
const (
	StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiffTypeSetOptions StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiffType = "SET_OPTIONS"
)

func (StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryAccountOwnershipsDiffType) IsKnown added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryTotalUsdDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryTotalUsdDiff struct {
	// Total incoming USD transfers
	In float64 `json:"in,required"`
	// Total outgoing USD transfers
	Out float64 `json:"out,required"`
	// Total USD transfers
	Total float64                                                                                       `json:"total"`
	JSON  stellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryTotalUsdDiffJSON `json:"-"`
}

Total USD diff for the requested account address

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAccountSummaryTotalUsdDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAddressDetail added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAddressDetail struct {
	// Encoded public key of the account
	AccountAddress interface{} `json:"account_address,required"`
	// Description of the account
	Description string                                                                           `json:"description,nullable"`
	JSON        stellarTransactionScanResponseSimulationStellarSimulationResultAddressDetailJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAddressDetail) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiff struct {
	// This field can have the runtime type of [StellarLegacyAssetDetails],
	// [StellarNativeAssetDetails], [StellarAssetContractDetails].
	Asset interface{} `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                   `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarContractAssetDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarContractAssetDiff struct {
	Asset StellarAssetContractDetails `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                                            `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarContractAssetDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarContractAssetDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarLegacyAssetDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarLegacyAssetDiff struct {
	Asset StellarLegacyAssetDetails `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                                          `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarLegacyAssetDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarLegacyAssetDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarNativeAssetDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarNativeAssetDiff struct {
	Asset StellarNativeAssetDetails `json:"asset,required"`
	// The type of the assets in this diff
	AssetType string `json:"asset_type,required"`
	// Details of the incoming transfer
	In StellarAssetTransferDetails `json:"in,nullable"`
	// Details of the outgoing transfer
	Out  StellarAssetTransferDetails                                                                          `json:"out,nullable"`
	JSON stellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarNativeAssetDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAssetsDiffsStellarNativeAssetDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiff added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiff struct {
	// List of public keys that can sign on behalf of the account post-transaction
	PostSigners []string `json:"post_signers,required"`
	// List of public keys that can sign on behalf of the account pre-transaction
	PreSigners []string                                                                               `json:"pre_signers,required"`
	Type       StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiffType `json:"type"`
	JSON       stellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiffJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiff) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiffType added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiffType string
const (
	StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiffTypeSetOptions StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiffType = "SET_OPTIONS"
)

func (StellarTransactionScanResponseSimulationStellarSimulationResultAssetsOwnershipDiffType) IsKnown added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposure added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposure struct {
	// This field can have the runtime type of [StellarLegacyAssetDetails],
	// [StellarNativeAssetDetails].
	Asset interface{} `json:"asset,required"`
	// This field can have the runtime type of [map[string]StellarSingleAssetExposure].
	Spenders interface{}                                                                 `json:"spenders"`
	JSON     stellarTransactionScanResponseSimulationStellarSimulationResultExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultExposure) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarLegacyAssetExposure added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarLegacyAssetExposure struct {
	Asset StellarLegacyAssetDetails `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StellarSingleAssetExposure                                                                  `json:"spenders"`
	JSON     stellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarLegacyAssetExposureJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarLegacyAssetExposure) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarNativeAssetExposure added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarNativeAssetExposure struct {
	Asset StellarNativeAssetDetails `json:"asset,required"`
	// Mapping between the spender address and the exposure of the asset
	Spenders map[string]StellarSingleAssetExposure                                                                  `json:"spenders"`
	JSON     stellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarNativeAssetExposureJSON `json:"-"`
}

func (*StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarNativeAssetExposure) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposuresUnion added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultExposuresUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarLegacyAssetExposure or StellarTransactionScanResponseSimulationStellarSimulationResultExposuresStellarNativeAssetExposure.

type StellarTransactionScanResponseSimulationStellarSimulationResultStatus added in v0.29.0

type StellarTransactionScanResponseSimulationStellarSimulationResultStatus string
const (
	StellarTransactionScanResponseSimulationStellarSimulationResultStatusSuccess StellarTransactionScanResponseSimulationStellarSimulationResultStatus = "Success"
)

func (StellarTransactionScanResponseSimulationStellarSimulationResultStatus) IsKnown added in v0.29.0

type StellarTransactionScanResponseSimulationUnion added in v0.11.0

type StellarTransactionScanResponseSimulationUnion interface {
	// contains filtered or unexported methods
}

Simulation result; Only present if simulation option is included in the request

Union satisfied by StellarTransactionScanResponseSimulationStellarSimulationResult or StellarTransactionScanResponseSimulationStellarSimulationErrorSchema.

type StellarTransactionScanResponseValidation added in v0.11.0

type StellarTransactionScanResponseValidation struct {
	Status StellarTransactionScanResponseValidationStatus `json:"status,required"`
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification"`
	// A textual description about the validation result
	Description string `json:"description"`
	// Error message
	Error string `json:"error"`
	// This field can have the runtime type of
	// [[]StellarTransactionScanResponseValidationStellarValidationResultFeature].
	Features interface{} `json:"features"`
	// A textual description about the reasons the transaction was flagged with
	// result_type
	Reason string `json:"reason"`
	// Verdict of the validation
	ResultType StellarTransactionScanResponseValidationResultType `json:"result_type"`
	JSON       stellarTransactionScanResponseValidationJSON       `json:"-"`
	// contains filtered or unexported fields
}

Validation result; Only present if validation option is included in the request

func (StellarTransactionScanResponseValidation) AsUnion added in v0.11.0

AsUnion returns a StellarTransactionScanResponseValidationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are StellarTransactionScanResponseValidationStellarValidationResult, StellarTransactionScanResponseValidationStellarValidationErrorSchema.

func (*StellarTransactionScanResponseValidation) UnmarshalJSON added in v0.11.0

func (r *StellarTransactionScanResponseValidation) UnmarshalJSON(data []byte) (err error)

type StellarTransactionScanResponseValidationResultType added in v0.11.0

type StellarTransactionScanResponseValidationResultType string

Verdict of the validation

const (
	StellarTransactionScanResponseValidationResultTypeBenign    StellarTransactionScanResponseValidationResultType = "Benign"
	StellarTransactionScanResponseValidationResultTypeWarning   StellarTransactionScanResponseValidationResultType = "Warning"
	StellarTransactionScanResponseValidationResultTypeMalicious StellarTransactionScanResponseValidationResultType = "Malicious"
)

func (StellarTransactionScanResponseValidationResultType) IsKnown added in v0.11.0

type StellarTransactionScanResponseValidationStatus added in v0.11.0

type StellarTransactionScanResponseValidationStatus string
const (
	StellarTransactionScanResponseValidationStatusSuccess StellarTransactionScanResponseValidationStatus = "Success"
	StellarTransactionScanResponseValidationStatusError   StellarTransactionScanResponseValidationStatus = "Error"
)

func (StellarTransactionScanResponseValidationStatus) IsKnown added in v0.11.0

type StellarTransactionScanResponseValidationStellarValidationErrorSchema added in v0.11.0

type StellarTransactionScanResponseValidationStellarValidationErrorSchema struct {
	// Error message
	Error  string                                                                     `json:"error,required"`
	Status StellarTransactionScanResponseValidationStellarValidationErrorSchemaStatus `json:"status,required"`
	JSON   stellarTransactionScanResponseValidationStellarValidationErrorSchemaJSON   `json:"-"`
}

func (*StellarTransactionScanResponseValidationStellarValidationErrorSchema) UnmarshalJSON added in v0.11.0

type StellarTransactionScanResponseValidationStellarValidationErrorSchemaStatus added in v0.11.0

type StellarTransactionScanResponseValidationStellarValidationErrorSchemaStatus string
const (
	StellarTransactionScanResponseValidationStellarValidationErrorSchemaStatusError StellarTransactionScanResponseValidationStellarValidationErrorSchemaStatus = "Error"
)

func (StellarTransactionScanResponseValidationStellarValidationErrorSchemaStatus) IsKnown added in v0.11.0

type StellarTransactionScanResponseValidationStellarValidationResult added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResult struct {
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification,required"`
	// A textual description about the validation result
	Description string                                                                   `json:"description,required"`
	Features    []StellarTransactionScanResponseValidationStellarValidationResultFeature `json:"features,required"`
	// A textual description about the reasons the transaction was flagged with
	// result_type
	Reason string `json:"reason,required"`
	// Verdict of the validation
	ResultType StellarTransactionScanResponseValidationStellarValidationResultResultType `json:"result_type,required"`
	Status     StellarTransactionScanResponseValidationStellarValidationResultStatus     `json:"status,required"`
	JSON       stellarTransactionScanResponseValidationStellarValidationResultJSON       `json:"-"`
}

func (*StellarTransactionScanResponseValidationStellarValidationResult) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultFeature added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultFeature struct {
	// Address the feature refers to
	Address string `json:"address,required"`
	// Textual description
	Description string `json:"description,required"`
	FeatureID   string `json:"feature_id,required"`
	// Feature Classification
	Type StellarTransactionScanResponseValidationStellarValidationResultFeaturesType `json:"type,required"`
	JSON stellarTransactionScanResponseValidationStellarValidationResultFeatureJSON  `json:"-"`
}

func (*StellarTransactionScanResponseValidationStellarValidationResultFeature) UnmarshalJSON added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultFeaturesType added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultFeaturesType string

Feature Classification

const (
	StellarTransactionScanResponseValidationStellarValidationResultFeaturesTypeBenign    StellarTransactionScanResponseValidationStellarValidationResultFeaturesType = "Benign"
	StellarTransactionScanResponseValidationStellarValidationResultFeaturesTypeWarning   StellarTransactionScanResponseValidationStellarValidationResultFeaturesType = "Warning"
	StellarTransactionScanResponseValidationStellarValidationResultFeaturesTypeMalicious StellarTransactionScanResponseValidationStellarValidationResultFeaturesType = "Malicious"
	StellarTransactionScanResponseValidationStellarValidationResultFeaturesTypeInfo      StellarTransactionScanResponseValidationStellarValidationResultFeaturesType = "Info"
)

func (StellarTransactionScanResponseValidationStellarValidationResultFeaturesType) IsKnown added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultResultType added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultResultType string

Verdict of the validation

const (
	StellarTransactionScanResponseValidationStellarValidationResultResultTypeBenign    StellarTransactionScanResponseValidationStellarValidationResultResultType = "Benign"
	StellarTransactionScanResponseValidationStellarValidationResultResultTypeWarning   StellarTransactionScanResponseValidationStellarValidationResultResultType = "Warning"
	StellarTransactionScanResponseValidationStellarValidationResultResultTypeMalicious StellarTransactionScanResponseValidationStellarValidationResultResultType = "Malicious"
)

func (StellarTransactionScanResponseValidationStellarValidationResultResultType) IsKnown added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultStatus added in v0.29.0

type StellarTransactionScanResponseValidationStellarValidationResultStatus string
const (
	StellarTransactionScanResponseValidationStellarValidationResultStatusSuccess StellarTransactionScanResponseValidationStellarValidationResultStatus = "Success"
)

func (StellarTransactionScanResponseValidationStellarValidationResultStatus) IsKnown added in v0.29.0

type StellarTransactionScanResponseValidationUnion added in v0.11.0

type StellarTransactionScanResponseValidationUnion interface {
	// contains filtered or unexported methods
}

Validation result; Only present if validation option is included in the request

Union satisfied by StellarTransactionScanResponseValidationStellarValidationResult or StellarTransactionScanResponseValidationStellarValidationErrorSchema.

type StellarTransactionService added in v0.11.0

type StellarTransactionService struct {
	Options []option.RequestOption
}

StellarTransactionService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewStellarTransactionService method instead.

func NewStellarTransactionService added in v0.11.0

func NewStellarTransactionService(opts ...option.RequestOption) (r *StellarTransactionService)

NewStellarTransactionService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*StellarTransactionService) Report added in v0.34.0

Report Transaction

func (*StellarTransactionService) Scan added in v0.11.0

Scan Transaction

type SuccessfulSimulationResultSchema added in v0.12.0

type SuccessfulSimulationResultSchema struct {
	// Summary of the requested account address
	AccountSummary AccountSummarySchema `json:"account_summary,required"`
	// Summary of the accounts involved in the transaction simulation
	AccountsDetails []SuccessfulSimulationResultSchemaAccountsDetail `json:"accounts_details,required"`
	// Summary of the assets involved in the transaction simulation
	AssetsDiff map[string][]SuccessfulSimulationResultSchemaAssetsDiff `json:"assets_diff,required"`
	// Summary of ownership changes, By account address
	AssetsOwnershipDiff map[string][]SuccessfulSimulationResultSchemaAssetsOwnershipDiff `json:"assets_ownership_diff,required"`
	// Summary of the delegations, by account address
	Delegations map[string][]DelegatedAssetDetailsSchema `json:"delegations,required"`
	JSON        successfulSimulationResultSchemaJSON     `json:"-"`
}

func (*SuccessfulSimulationResultSchema) UnmarshalJSON added in v0.12.0

func (r *SuccessfulSimulationResultSchema) UnmarshalJSON(data []byte) (err error)

type SuccessfulSimulationResultSchemaAccountsDetail added in v0.12.0

type SuccessfulSimulationResultSchemaAccountsDetail struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string `json:"description,nullable"`
	Logo string `json:"logo"`
	// Encoded public key of the mint
	MintAddress string `json:"mint_address"`
	// Name of the mint
	Name string `json:"name"`
	// The address of the owning program
	Owner string `json:"owner"`
	// Encoded public key of the owner
	OwnerAddress string `json:"owner_address"`
	// Symbol of the mint
	Symbol string                                              `json:"symbol"`
	Type   SuccessfulSimulationResultSchemaAccountsDetailsType `json:"type"`
	// URI of the mint
	Uri  string                                             `json:"uri"`
	JSON successfulSimulationResultSchemaAccountsDetailJSON `json:"-"`
	// contains filtered or unexported fields
}

func (SuccessfulSimulationResultSchemaAccountsDetail) AsUnion added in v0.12.0

AsUnion returns a SuccessfulSimulationResultSchemaAccountsDetailsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SystemAccountDetailsSchema, TokenAccountDetailsSchema, FungibleMintAccountDetailsSchema, NonFungibleMintAccountDetailsSchema, ProgramAccountDetailsSchema, PdaAccountSchema, CnftMintAccountDetailsSchema.

func (*SuccessfulSimulationResultSchemaAccountsDetail) UnmarshalJSON added in v0.12.0

func (r *SuccessfulSimulationResultSchemaAccountsDetail) UnmarshalJSON(data []byte) (err error)

type SuccessfulSimulationResultSchemaAccountsDetailsType added in v0.12.0

type SuccessfulSimulationResultSchemaAccountsDetailsType string
const (
	SuccessfulSimulationResultSchemaAccountsDetailsTypeSystemAccount          SuccessfulSimulationResultSchemaAccountsDetailsType = "SYSTEM_ACCOUNT"
	SuccessfulSimulationResultSchemaAccountsDetailsTypeTokenAccount           SuccessfulSimulationResultSchemaAccountsDetailsType = "TOKEN_ACCOUNT"
	SuccessfulSimulationResultSchemaAccountsDetailsTypeFungibleMintAccount    SuccessfulSimulationResultSchemaAccountsDetailsType = "FUNGIBLE_MINT_ACCOUNT"
	SuccessfulSimulationResultSchemaAccountsDetailsTypeNonFungibleMintAccount SuccessfulSimulationResultSchemaAccountsDetailsType = "NON_FUNGIBLE_MINT_ACCOUNT"
	SuccessfulSimulationResultSchemaAccountsDetailsTypeProgram                SuccessfulSimulationResultSchemaAccountsDetailsType = "PROGRAM"
	SuccessfulSimulationResultSchemaAccountsDetailsTypeNativeProgram          SuccessfulSimulationResultSchemaAccountsDetailsType = "NATIVE_PROGRAM"
	SuccessfulSimulationResultSchemaAccountsDetailsTypePda                    SuccessfulSimulationResultSchemaAccountsDetailsType = "PDA"
	SuccessfulSimulationResultSchemaAccountsDetailsTypeCnftMintAccount        SuccessfulSimulationResultSchemaAccountsDetailsType = "CNFT_MINT_ACCOUNT"
)

func (SuccessfulSimulationResultSchemaAccountsDetailsType) IsKnown added in v0.12.0

type SuccessfulSimulationResultSchemaAccountsDetailsUnion added in v0.12.0

type SuccessfulSimulationResultSchemaAccountsDetailsUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SystemAccountDetailsSchema, TokenAccountDetailsSchema, FungibleMintAccountDetailsSchema, NonFungibleMintAccountDetailsSchema, ProgramAccountDetailsSchema, PdaAccountSchema or CnftMintAccountDetailsSchema.

type SuccessfulSimulationResultSchemaAssetsDiff added in v0.12.0

type SuccessfulSimulationResultSchemaAssetsDiff struct {
	// This field can have the runtime type of [NativeDetailsSchema],
	// [SplFungibleTokenDetailsSchema], [SplNonFungibleTokenDetailsSchema],
	// [CnftDetailsSchema].
	Asset interface{} `json:"asset,required"`
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// Incoming transfers of the asset
	In   AssetTransferDetailsSchema                     `json:"in,nullable"`
	Out  AssetTransferDetailsSchema                     `json:"out,nullable"`
	JSON successfulSimulationResultSchemaAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (SuccessfulSimulationResultSchemaAssetsDiff) AsUnion added in v0.12.0

AsUnion returns a SuccessfulSimulationResultSchemaAssetsDiffUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are NativeDiffSchema, SplFungibleTokenDiffSchema, SplNonFungibleTokenDiffSchema, CnftDiffSchema.

func (*SuccessfulSimulationResultSchemaAssetsDiff) UnmarshalJSON added in v0.12.0

func (r *SuccessfulSimulationResultSchemaAssetsDiff) UnmarshalJSON(data []byte) (err error)

type SuccessfulSimulationResultSchemaAssetsDiffUnion added in v0.12.0

type SuccessfulSimulationResultSchemaAssetsDiffUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by NativeDiffSchema, SplFungibleTokenDiffSchema, SplNonFungibleTokenDiffSchema or CnftDiffSchema.

type SuccessfulSimulationResultSchemaAssetsOwnershipDiff added in v0.12.0

type SuccessfulSimulationResultSchemaAssetsOwnershipDiff struct {
	// Type of the asset involved in the transfer
	AssetType string `json:"asset_type,required"`
	// The owner post the transaction
	PostOwner string `json:"post_owner,required"`
	// This field can have the runtime type of [NativeDetailsSchema],
	// [SplTokenOwnershipDiffSchemaAsset], [StakedAssetDetailsSchema].
	Asset interface{} `json:"asset"`
	// Incoming transfers of the asset
	In AssetTransferDetailsSchema `json:"in_,nullable"`
	// Details of the moved value
	Out AssetTransferDetailsSchema `json:"out,nullable"`
	// The owner prior to the transaction
	PreOwner string                                                  `json:"pre_owner,nullable"`
	JSON     successfulSimulationResultSchemaAssetsOwnershipDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (SuccessfulSimulationResultSchemaAssetsOwnershipDiff) AsUnion added in v0.12.0

AsUnion returns a SuccessfulSimulationResultSchemaAssetsOwnershipDiffUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are NativeSolOwnershipDiffSchema, SplTokenOwnershipDiffSchema, StakedSolWithdrawAuthorityDiffSchema.

func (*SuccessfulSimulationResultSchemaAssetsOwnershipDiff) UnmarshalJSON added in v0.12.0

func (r *SuccessfulSimulationResultSchemaAssetsOwnershipDiff) UnmarshalJSON(data []byte) (err error)

type SuccessfulSimulationResultSchemaAssetsOwnershipDiffUnion added in v0.12.0

type SuccessfulSimulationResultSchemaAssetsOwnershipDiffUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by NativeSolOwnershipDiffSchema, SplTokenOwnershipDiffSchema or StakedSolWithdrawAuthorityDiffSchema.

type SystemAccountDetailsSchema added in v0.12.0

type SystemAccountDetailsSchema struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string                         `json:"description,nullable"`
	Type        SystemAccountDetailsSchemaType `json:"type"`
	JSON        systemAccountDetailsSchemaJSON `json:"-"`
}

func (*SystemAccountDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *SystemAccountDetailsSchema) UnmarshalJSON(data []byte) (err error)

type SystemAccountDetailsSchemaType added in v0.12.0

type SystemAccountDetailsSchemaType string
const (
	SystemAccountDetailsSchemaTypeSystemAccount SystemAccountDetailsSchemaType = "SYSTEM_ACCOUNT"
)

func (SystemAccountDetailsSchemaType) IsKnown added in v0.12.0

type TokenAccountDetailsSchema added in v0.12.0

type TokenAccountDetailsSchema struct {
	// Encoded public key of the account
	AccountAddress string `json:"account_address,required"`
	// Encoded public key of the mint
	MintAddress string `json:"mint_address,required"`
	// Encoded public key of the owner
	OwnerAddress string `json:"owner_address,required"`
	// Whether the account had been written to during the simulation
	WasWrittenTo bool `json:"was_written_to,required"`
	// Description of the account
	Description string                        `json:"description,nullable"`
	Type        TokenAccountDetailsSchemaType `json:"type"`
	JSON        tokenAccountDetailsSchemaJSON `json:"-"`
}

func (*TokenAccountDetailsSchema) UnmarshalJSON added in v0.12.0

func (r *TokenAccountDetailsSchema) UnmarshalJSON(data []byte) (err error)

type TokenAccountDetailsSchemaType added in v0.12.0

type TokenAccountDetailsSchemaType string
const (
	TokenAccountDetailsSchemaTypeTokenAccount TokenAccountDetailsSchemaType = "TOKEN_ACCOUNT"
)

func (TokenAccountDetailsSchemaType) IsKnown added in v0.12.0

func (r TokenAccountDetailsSchemaType) IsKnown() bool

type TokenBulkScanParams added in v0.18.0

type TokenBulkScanParams struct {
	// The chain name
	Chain param.Field[TokenScanSupportedChain] `json:"chain,required"`
	// A list of token addresses to scan
	Tokens param.Field[[]string] `json:"tokens,required"`
	// Object of additional information to validate against.
	Metadata param.Field[TokenBulkScanParamsMetadata] `json:"metadata"`
}

func (TokenBulkScanParams) MarshalJSON added in v0.18.0

func (r TokenBulkScanParams) MarshalJSON() (data []byte, err error)

type TokenBulkScanParamsMetadata added in v0.18.0

type TokenBulkScanParamsMetadata struct {
	// cross reference transaction against the domain.
	Domain param.Field[string] `json:"domain"`
}

Object of additional information to validate against.

func (TokenBulkScanParamsMetadata) MarshalJSON added in v0.18.0

func (r TokenBulkScanParamsMetadata) MarshalJSON() (data []byte, err error)

type TokenBulkScanResponse added in v0.18.0

type TokenBulkScanResponse struct {
	Results map[string]TokenBulkScanResponseResult `json:"results,required"`
	JSON    tokenBulkScanResponseJSON              `json:"-"`
}

func (*TokenBulkScanResponse) UnmarshalJSON added in v0.18.0

func (r *TokenBulkScanResponse) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResult added in v0.18.0

type TokenBulkScanResponseResult struct {
	// Token address to validate (EVM / Solana)
	Address string `json:"address,required"`
	// Dictionary of detected attacks found during the scan
	AttackTypes map[string]TokenBulkScanResponseResultsAttackType `json:"attack_types,required"`
	// The chain name
	Chain TokenScanSupportedChain `json:"chain,required"`
	// Fees associated with the token
	Fees TokenBulkScanResponseResultsFees `json:"fees,required"`
	// financial stats of the token
	FinancialStats TokenBulkScanResponseResultsFinancialStats `json:"financial_stats,required"`
	// Score between 0 to 1 (double)
	MaliciousScore string `json:"malicious_score,required"`
	// Metadata of the token
	Metadata TokenBulkScanResponseResultsMetadata `json:"metadata,required"`
	// An enumeration.
	ResultType TokenBulkScanResponseResultsResultType `json:"result_type,required"`
	// Trading limits of the token
	TradingLimits TokenBulkScanResponseResultsTradingLimits `json:"trading_limits,required"`
	// List of features associated with the token
	Features []TokenBulkScanResponseResultsFeature `json:"features"`
	JSON     tokenBulkScanResponseResultJSON       `json:"-"`
}

func (*TokenBulkScanResponseResult) UnmarshalJSON added in v0.18.0

func (r *TokenBulkScanResponseResult) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsAttackType added in v0.18.0

type TokenBulkScanResponseResultsAttackType struct {
	// Score between 0 to 1 (double) that indicates the assurance this attack happened
	Score string `json:"score,required"`
	// Object contains an extra information related to the attack
	Features interface{} `json:"features"`
	// If score is higher or equal to this field, the token is using this attack type
	Threshold string                                     `json:"threshold"`
	JSON      tokenBulkScanResponseResultsAttackTypeJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsAttackType) UnmarshalJSON added in v0.18.0

func (r *TokenBulkScanResponseResultsAttackType) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsFeature added in v0.22.1

type TokenBulkScanResponseResultsFeature struct {
	// Description of the feature
	Description string `json:"description,required"`
	// An enumeration.
	FeatureID TokenBulkScanResponseResultsFeaturesFeatureID `json:"feature_id,required"`
	// An enumeration.
	Type TokenBulkScanResponseResultsFeaturesType `json:"type,required"`
	JSON tokenBulkScanResponseResultsFeatureJSON  `json:"-"`
}

func (*TokenBulkScanResponseResultsFeature) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsFeature) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsFeaturesFeatureID added in v0.22.1

type TokenBulkScanResponseResultsFeaturesFeatureID string

An enumeration.

const (
	TokenBulkScanResponseResultsFeaturesFeatureIDVerifiedContract               TokenBulkScanResponseResultsFeaturesFeatureID = "VERIFIED_CONTRACT"
	TokenBulkScanResponseResultsFeaturesFeatureIDHighTradeVolume                TokenBulkScanResponseResultsFeaturesFeatureID = "HIGH_TRADE_VOLUME"
	TokenBulkScanResponseResultsFeaturesFeatureIDMarketPlaceSalesHistory        TokenBulkScanResponseResultsFeaturesFeatureID = "MARKET_PLACE_SALES_HISTORY"
	TokenBulkScanResponseResultsFeaturesFeatureIDHighReputationToken            TokenBulkScanResponseResultsFeaturesFeatureID = "HIGH_REPUTATION_TOKEN"
	TokenBulkScanResponseResultsFeaturesFeatureIDOnchainActivityValidator       TokenBulkScanResponseResultsFeaturesFeatureID = "ONCHAIN_ACTIVITY_VALIDATOR"
	TokenBulkScanResponseResultsFeaturesFeatureIDStaticCodeSignature            TokenBulkScanResponseResultsFeaturesFeatureID = "STATIC_CODE_SIGNATURE"
	TokenBulkScanResponseResultsFeaturesFeatureIDKnownMalicious                 TokenBulkScanResponseResultsFeaturesFeatureID = "KNOWN_MALICIOUS"
	TokenBulkScanResponseResultsFeaturesFeatureIDMetadata                       TokenBulkScanResponseResultsFeaturesFeatureID = "METADATA"
	TokenBulkScanResponseResultsFeaturesFeatureIDAirdropPattern                 TokenBulkScanResponseResultsFeaturesFeatureID = "AIRDROP_PATTERN"
	TokenBulkScanResponseResultsFeaturesFeatureIDImpersonator                   TokenBulkScanResponseResultsFeaturesFeatureID = "IMPERSONATOR"
	TokenBulkScanResponseResultsFeaturesFeatureIDInorganicVolume                TokenBulkScanResponseResultsFeaturesFeatureID = "INORGANIC_VOLUME"
	TokenBulkScanResponseResultsFeaturesFeatureIDDynamicAnalysis                TokenBulkScanResponseResultsFeaturesFeatureID = "DYNAMIC_ANALYSIS"
	TokenBulkScanResponseResultsFeaturesFeatureIDUnstableTokenPrice             TokenBulkScanResponseResultsFeaturesFeatureID = "UNSTABLE_TOKEN_PRICE"
	TokenBulkScanResponseResultsFeaturesFeatureIDRugpull                        TokenBulkScanResponseResultsFeaturesFeatureID = "RUGPULL"
	TokenBulkScanResponseResultsFeaturesFeatureIDConsumerOverride               TokenBulkScanResponseResultsFeaturesFeatureID = "CONSUMER_OVERRIDE"
	TokenBulkScanResponseResultsFeaturesFeatureIDInappropriateContent           TokenBulkScanResponseResultsFeaturesFeatureID = "INAPPROPRIATE_CONTENT"
	TokenBulkScanResponseResultsFeaturesFeatureIDHighTransferFee                TokenBulkScanResponseResultsFeaturesFeatureID = "HIGH_TRANSFER_FEE"
	TokenBulkScanResponseResultsFeaturesFeatureIDHighBuyFee                     TokenBulkScanResponseResultsFeaturesFeatureID = "HIGH_BUY_FEE"
	TokenBulkScanResponseResultsFeaturesFeatureIDHighSellFee                    TokenBulkScanResponseResultsFeaturesFeatureID = "HIGH_SELL_FEE"
	TokenBulkScanResponseResultsFeaturesFeatureIDIsMintable                     TokenBulkScanResponseResultsFeaturesFeatureID = "IS_MINTABLE"
	TokenBulkScanResponseResultsFeaturesFeatureIDModifiableTaxes                TokenBulkScanResponseResultsFeaturesFeatureID = "MODIFIABLE_TAXES"
	TokenBulkScanResponseResultsFeaturesFeatureIDCanBlacklist                   TokenBulkScanResponseResultsFeaturesFeatureID = "CAN_BLACKLIST"
	TokenBulkScanResponseResultsFeaturesFeatureIDCanWhitelist                   TokenBulkScanResponseResultsFeaturesFeatureID = "CAN_WHITELIST"
	TokenBulkScanResponseResultsFeaturesFeatureIDHasTradingCooldown             TokenBulkScanResponseResultsFeaturesFeatureID = "HAS_TRADING_COOLDOWN"
	TokenBulkScanResponseResultsFeaturesFeatureIDExternalFunctions              TokenBulkScanResponseResultsFeaturesFeatureID = "EXTERNAL_FUNCTIONS"
	TokenBulkScanResponseResultsFeaturesFeatureIDHiddenOwner                    TokenBulkScanResponseResultsFeaturesFeatureID = "HIDDEN_OWNER"
	TokenBulkScanResponseResultsFeaturesFeatureIDTransferPauseable              TokenBulkScanResponseResultsFeaturesFeatureID = "TRANSFER_PAUSEABLE"
	TokenBulkScanResponseResultsFeaturesFeatureIDOwnershipRenounced             TokenBulkScanResponseResultsFeaturesFeatureID = "OWNERSHIP_RENOUNCED"
	TokenBulkScanResponseResultsFeaturesFeatureIDProxyContract                  TokenBulkScanResponseResultsFeaturesFeatureID = "PROXY_CONTRACT"
	TokenBulkScanResponseResultsFeaturesFeatureIDLiquidStake                    TokenBulkScanResponseResultsFeaturesFeatureID = "LIQUID_STAKE"
	TokenBulkScanResponseResultsFeaturesFeatureIDRebaseToken                    TokenBulkScanResponseResultsFeaturesFeatureID = "REBASE_TOKEN"
	TokenBulkScanResponseResultsFeaturesFeatureIDUnsellableToken                TokenBulkScanResponseResultsFeaturesFeatureID = "UNSELLABLE_TOKEN"
	TokenBulkScanResponseResultsFeaturesFeatureIDConcentratedSupplyDistribution TokenBulkScanResponseResultsFeaturesFeatureID = "CONCENTRATED_SUPPLY_DISTRIBUTION"
	TokenBulkScanResponseResultsFeaturesFeatureIDInsufficientLockedLiquidity    TokenBulkScanResponseResultsFeaturesFeatureID = "INSUFFICIENT_LOCKED_LIQUIDITY"
	TokenBulkScanResponseResultsFeaturesFeatureIDHoneypot                       TokenBulkScanResponseResultsFeaturesFeatureID = "HONEYPOT"
)

func (TokenBulkScanResponseResultsFeaturesFeatureID) IsKnown added in v0.22.1

type TokenBulkScanResponseResultsFeaturesType added in v0.22.1

type TokenBulkScanResponseResultsFeaturesType string

An enumeration.

const (
	TokenBulkScanResponseResultsFeaturesTypeBenign    TokenBulkScanResponseResultsFeaturesType = "Benign"
	TokenBulkScanResponseResultsFeaturesTypeInfo      TokenBulkScanResponseResultsFeaturesType = "Info"
	TokenBulkScanResponseResultsFeaturesTypeWarning   TokenBulkScanResponseResultsFeaturesType = "Warning"
	TokenBulkScanResponseResultsFeaturesTypeMalicious TokenBulkScanResponseResultsFeaturesType = "Malicious"
)

func (TokenBulkScanResponseResultsFeaturesType) IsKnown added in v0.22.1

type TokenBulkScanResponseResultsFees added in v0.22.1

type TokenBulkScanResponseResultsFees struct {
	// Buy fee of the token
	Buy float64 `json:"buy"`
	// Sell fee of the token
	Sell float64 `json:"sell"`
	// Transfer fee of the token
	Transfer float64                              `json:"transfer"`
	JSON     tokenBulkScanResponseResultsFeesJSON `json:"-"`
}

Fees associated with the token

func (*TokenBulkScanResponseResultsFees) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsFees) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsFinancialStats added in v0.22.1

type TokenBulkScanResponseResultsFinancialStats struct {
	BurnedLiquidityPercentage float64                                               `json:"burned_liquidity_percentage"`
	HoldersCount              int64                                                 `json:"holders_count"`
	LockedLiquidityPercentage float64                                               `json:"locked_liquidity_percentage"`
	TopHolders                []TokenBulkScanResponseResultsFinancialStatsTopHolder `json:"top_holders"`
	UsdPricePerUnit           float64                                               `json:"usd_price_per_unit"`
	JSON                      tokenBulkScanResponseResultsFinancialStatsJSON        `json:"-"`
}

financial stats of the token

func (*TokenBulkScanResponseResultsFinancialStats) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsFinancialStats) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsFinancialStatsTopHolder added in v0.22.1

type TokenBulkScanResponseResultsFinancialStatsTopHolder struct {
	Address           string                                                  `json:"address"`
	HoldingPercentage float64                                                 `json:"holding_percentage"`
	JSON              tokenBulkScanResponseResultsFinancialStatsTopHolderJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsFinancialStatsTopHolder) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsFinancialStatsTopHolder) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsMetadata added in v0.22.1

type TokenBulkScanResponseResultsMetadata struct {
	// The unique ID for the Rune
	ID string `json:"id"`
	// This field can have the runtime type of
	// [TokenBulkScanResponseResultsMetadataSolanaMetadataContractBalance],
	// [TokenBulkScanResponseResultsMetadataEvmMetadataTokenContractBalance].
	ContractBalance interface{} `json:"contract_balance"`
	// Contract deploy date
	CreationTimestamp time.Time `json:"creation_timestamp" format:"date-time"`
	// Address of the deployer of the fungible token
	Deployer string `json:"deployer"`
	// Description of the token
	Description string `json:"description"`
	// This field can have the runtime type of
	// [TokenBulkScanResponseResultsMetadataSolanaMetadataExternalLinks],
	// [TokenBulkScanResponseResultsMetadataEvmMetadataTokenExternalLinks].
	ExternalLinks interface{} `json:"external_links"`
	// The formatted name of the rune, with spacers
	FormattedName string `json:"formatted_name"`
	// Solana token freeze authority account
	FreezeAuthority string `json:"freeze_authority"`
	// URL of the token image
	ImageURL string `json:"image_url"`
	// Solana token mint authority account
	MintAuthority string `json:"mint_authority"`
	// Name of the token
	Name string `json:"name"`
	// The rune's unique sequential number.
	Number int64 `json:"number"`
	// Contract owner address
	Owner string `json:"owner"`
	// This field can have the runtime type of
	// [TokenBulkScanResponseResultsMetadataSolanaMetadataOwnerBalance],
	// [TokenBulkScanResponseResultsMetadataEvmMetadataTokenOwnerBalance].
	OwnerBalance interface{} `json:"owner_balance"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string `json:"type"`
	// Solana token update authority account
	UpdateAuthority string                                   `json:"update_authority"`
	JSON            tokenBulkScanResponseResultsMetadataJSON `json:"-"`
	// contains filtered or unexported fields
}

Metadata of the token

func (TokenBulkScanResponseResultsMetadata) AsUnion added in v0.22.1

AsUnion returns a TokenBulkScanResponseResultsMetadataUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TokenBulkScanResponseResultsMetadataSolanaMetadata, TokenBulkScanResponseResultsMetadataBitcoinMetadataToken, TokenBulkScanResponseResultsMetadataEvmMetadataToken.

func (*TokenBulkScanResponseResultsMetadata) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsMetadata) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsMetadataBitcoinMetadataToken added in v0.27.0

type TokenBulkScanResponseResultsMetadataBitcoinMetadataToken struct {
	// The unique ID for the Rune
	ID string `json:"id"`
	// The formatted name of the rune, with spacers
	FormattedName string `json:"formatted_name"`
	// Name of the token
	Name string `json:"name"`
	// The rune's unique sequential number.
	Number int64 `json:"number"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string                                                       `json:"type"`
	JSON tokenBulkScanResponseResultsMetadataBitcoinMetadataTokenJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsMetadataBitcoinMetadataToken) UnmarshalJSON added in v0.27.0

type TokenBulkScanResponseResultsMetadataEvmMetadataToken added in v0.27.0

type TokenBulkScanResponseResultsMetadataEvmMetadataToken struct {
	// Contract balance
	ContractBalance TokenBulkScanResponseResultsMetadataEvmMetadataTokenContractBalance `json:"contract_balance"`
	// Contract deploy date
	CreationTimestamp time.Time `json:"creation_timestamp" format:"date-time"`
	// Address of the deployer of the fungible token
	Deployer string `json:"deployer"`
	// Description of the token
	Description string `json:"description"`
	// social links of the token
	ExternalLinks TokenBulkScanResponseResultsMetadataEvmMetadataTokenExternalLinks `json:"external_links"`
	// URL of the token image
	ImageURL string `json:"image_url"`
	// Name of the token
	Name string `json:"name"`
	// Contract owner address
	Owner string `json:"owner"`
	// Contract owner balance
	OwnerBalance TokenBulkScanResponseResultsMetadataEvmMetadataTokenOwnerBalance `json:"owner_balance"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string                                                   `json:"type"`
	JSON tokenBulkScanResponseResultsMetadataEvmMetadataTokenJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsMetadataEvmMetadataToken) UnmarshalJSON added in v0.27.0

func (r *TokenBulkScanResponseResultsMetadataEvmMetadataToken) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsMetadataEvmMetadataTokenContractBalance added in v0.27.0

type TokenBulkScanResponseResultsMetadataEvmMetadataTokenContractBalance struct {
	Amount    float64                                                                 `json:"amount"`
	AmountWei string                                                                  `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsMetadataEvmMetadataTokenContractBalanceJSON `json:"-"`
}

Contract balance

func (*TokenBulkScanResponseResultsMetadataEvmMetadataTokenContractBalance) UnmarshalJSON added in v0.27.0

type TokenBulkScanResponseResultsMetadataEvmMetadataTokenExternalLinks struct {
	Homepage          string                                                                `json:"homepage"`
	TelegramChannelID string                                                                `json:"telegram_channel_id"`
	TwitterPage       string                                                                `json:"twitter_page"`
	JSON              tokenBulkScanResponseResultsMetadataEvmMetadataTokenExternalLinksJSON `json:"-"`
}

social links of the token

func (*TokenBulkScanResponseResultsMetadataEvmMetadataTokenExternalLinks) UnmarshalJSON added in v0.27.0

type TokenBulkScanResponseResultsMetadataEvmMetadataTokenOwnerBalance added in v0.27.0

type TokenBulkScanResponseResultsMetadataEvmMetadataTokenOwnerBalance struct {
	Amount    float64                                                              `json:"amount"`
	AmountWei string                                                               `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsMetadataEvmMetadataTokenOwnerBalanceJSON `json:"-"`
}

Contract owner balance

func (*TokenBulkScanResponseResultsMetadataEvmMetadataTokenOwnerBalance) UnmarshalJSON added in v0.27.0

type TokenBulkScanResponseResultsMetadataSolanaMetadata added in v0.22.1

type TokenBulkScanResponseResultsMetadataSolanaMetadata struct {
	// Contract balance
	ContractBalance TokenBulkScanResponseResultsMetadataSolanaMetadataContractBalance `json:"contract_balance"`
	// Contract deploy date
	CreationTimestamp time.Time `json:"creation_timestamp" format:"date-time"`
	// Address of the deployer of the fungible token
	Deployer string `json:"deployer"`
	// Description of the token
	Description string `json:"description"`
	// social links of the token
	ExternalLinks TokenBulkScanResponseResultsMetadataSolanaMetadataExternalLinks `json:"external_links"`
	// Solana token freeze authority account
	FreezeAuthority string `json:"freeze_authority"`
	// URL of the token image
	ImageURL string `json:"image_url"`
	// Solana token mint authority account
	MintAuthority string `json:"mint_authority"`
	// Name of the token
	Name string `json:"name"`
	// Contract owner address
	Owner string `json:"owner"`
	// Contract owner balance
	OwnerBalance TokenBulkScanResponseResultsMetadataSolanaMetadataOwnerBalance `json:"owner_balance"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string `json:"type"`
	// Solana token update authority account
	UpdateAuthority string                                                 `json:"update_authority"`
	JSON            tokenBulkScanResponseResultsMetadataSolanaMetadataJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsMetadataSolanaMetadata) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsMetadataSolanaMetadata) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsMetadataSolanaMetadataContractBalance added in v0.27.0

type TokenBulkScanResponseResultsMetadataSolanaMetadataContractBalance struct {
	Amount    float64                                                               `json:"amount"`
	AmountWei string                                                                `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsMetadataSolanaMetadataContractBalanceJSON `json:"-"`
}

Contract balance

func (*TokenBulkScanResponseResultsMetadataSolanaMetadataContractBalance) UnmarshalJSON added in v0.27.0

type TokenBulkScanResponseResultsMetadataSolanaMetadataExternalLinks struct {
	Homepage          string                                                              `json:"homepage"`
	TelegramChannelID string                                                              `json:"telegram_channel_id"`
	TwitterPage       string                                                              `json:"twitter_page"`
	JSON              tokenBulkScanResponseResultsMetadataSolanaMetadataExternalLinksJSON `json:"-"`
}

social links of the token

func (*TokenBulkScanResponseResultsMetadataSolanaMetadataExternalLinks) UnmarshalJSON added in v0.27.0

type TokenBulkScanResponseResultsMetadataSolanaMetadataOwnerBalance added in v0.27.0

type TokenBulkScanResponseResultsMetadataSolanaMetadataOwnerBalance struct {
	Amount    float64                                                            `json:"amount"`
	AmountWei string                                                             `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsMetadataSolanaMetadataOwnerBalanceJSON `json:"-"`
}

Contract owner balance

func (*TokenBulkScanResponseResultsMetadataSolanaMetadataOwnerBalance) UnmarshalJSON added in v0.27.0

type TokenBulkScanResponseResultsMetadataUnion added in v0.22.1

type TokenBulkScanResponseResultsMetadataUnion interface {
	// contains filtered or unexported methods
}

Metadata of the token

Union satisfied by TokenBulkScanResponseResultsMetadataSolanaMetadata, TokenBulkScanResponseResultsMetadataBitcoinMetadataToken or TokenBulkScanResponseResultsMetadataEvmMetadataToken.

type TokenBulkScanResponseResultsResultType added in v0.18.0

type TokenBulkScanResponseResultsResultType string

An enumeration.

const (
	TokenBulkScanResponseResultsResultTypeBenign    TokenBulkScanResponseResultsResultType = "Benign"
	TokenBulkScanResponseResultsResultTypeWarning   TokenBulkScanResponseResultsResultType = "Warning"
	TokenBulkScanResponseResultsResultTypeMalicious TokenBulkScanResponseResultsResultType = "Malicious"
	TokenBulkScanResponseResultsResultTypeSpam      TokenBulkScanResponseResultsResultType = "Spam"
)

func (TokenBulkScanResponseResultsResultType) IsKnown added in v0.18.0

type TokenBulkScanResponseResultsTradingLimits added in v0.22.1

type TokenBulkScanResponseResultsTradingLimits struct {
	MaxBuy            TokenBulkScanResponseResultsTradingLimitsMaxBuy            `json:"max_buy"`
	MaxHolding        TokenBulkScanResponseResultsTradingLimitsMaxHolding        `json:"max_holding"`
	MaxSell           TokenBulkScanResponseResultsTradingLimitsMaxSell           `json:"max_sell"`
	SellLimitPerBlock TokenBulkScanResponseResultsTradingLimitsSellLimitPerBlock `json:"sell_limit_per_block"`
	JSON              tokenBulkScanResponseResultsTradingLimitsJSON              `json:"-"`
}

Trading limits of the token

func (*TokenBulkScanResponseResultsTradingLimits) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsTradingLimits) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsTradingLimitsMaxBuy added in v0.22.1

type TokenBulkScanResponseResultsTradingLimitsMaxBuy struct {
	Amount    float64                                             `json:"amount"`
	AmountWei string                                              `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsTradingLimitsMaxBuyJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsTradingLimitsMaxBuy) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsTradingLimitsMaxBuy) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsTradingLimitsMaxHolding added in v0.22.1

type TokenBulkScanResponseResultsTradingLimitsMaxHolding struct {
	Amount    float64                                                 `json:"amount"`
	AmountWei string                                                  `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsTradingLimitsMaxHoldingJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsTradingLimitsMaxHolding) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsTradingLimitsMaxHolding) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsTradingLimitsMaxSell added in v0.22.1

type TokenBulkScanResponseResultsTradingLimitsMaxSell struct {
	Amount    float64                                              `json:"amount"`
	AmountWei string                                               `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsTradingLimitsMaxSellJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsTradingLimitsMaxSell) UnmarshalJSON added in v0.22.1

func (r *TokenBulkScanResponseResultsTradingLimitsMaxSell) UnmarshalJSON(data []byte) (err error)

type TokenBulkScanResponseResultsTradingLimitsSellLimitPerBlock added in v0.22.1

type TokenBulkScanResponseResultsTradingLimitsSellLimitPerBlock struct {
	Amount    float64                                                        `json:"amount"`
	AmountWei string                                                         `json:"amount_wei"`
	JSON      tokenBulkScanResponseResultsTradingLimitsSellLimitPerBlockJSON `json:"-"`
}

func (*TokenBulkScanResponseResultsTradingLimitsSellLimitPerBlock) UnmarshalJSON added in v0.22.1

type TokenBulkService added in v0.18.0

type TokenBulkService struct {
	Options []option.RequestOption
}

TokenBulkService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTokenBulkService method instead.

func NewTokenBulkService added in v0.18.0

func NewTokenBulkService(opts ...option.RequestOption) (r *TokenBulkService)

NewTokenBulkService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TokenBulkService) Scan added in v0.18.0

Gets a list of token addresses and scan the tokens to identify any indication of malicious behaviour

type TokenReportParams added in v0.15.0

type TokenReportParams struct {
	// Details about the report.
	Details param.Field[string] `json:"details,required"`
	// An enumeration.
	Event param.Field[TokenReportParamsEvent] `json:"event,required"`
	// The report parameters.
	Report param.Field[TokenReportParamsReportUnion] `json:"report,required"`
}

func (TokenReportParams) MarshalJSON added in v0.15.0

func (r TokenReportParams) MarshalJSON() (data []byte, err error)

type TokenReportParamsEvent added in v0.15.0

type TokenReportParamsEvent string

An enumeration.

const (
	TokenReportParamsEventFalsePositive TokenReportParamsEvent = "FALSE_POSITIVE"
	TokenReportParamsEventFalseNegative TokenReportParamsEvent = "FALSE_NEGATIVE"
)

func (TokenReportParamsEvent) IsKnown added in v0.15.0

func (r TokenReportParamsEvent) IsKnown() bool

type TokenReportParamsReport added in v0.15.0

type TokenReportParamsReport struct {
	Type      param.Field[TokenReportParamsReportType] `json:"type,required"`
	Params    param.Field[interface{}]                 `json:"params"`
	RequestID param.Field[string]                      `json:"request_id"`
}

The report parameters.

func (TokenReportParamsReport) MarshalJSON added in v0.15.0

func (r TokenReportParamsReport) MarshalJSON() (data []byte, err error)

type TokenReportParamsReportParamReportTokenReportParams added in v0.16.0

type TokenReportParamsReportParamReportTokenReportParams struct {
	Params param.Field[TokenReportParamsReportParamReportTokenReportParamsParams] `json:"params,required"`
	Type   param.Field[TokenReportParamsReportParamReportTokenReportParamsType]   `json:"type,required"`
}

func (TokenReportParamsReportParamReportTokenReportParams) MarshalJSON added in v0.16.0

func (r TokenReportParamsReportParamReportTokenReportParams) MarshalJSON() (data []byte, err error)

type TokenReportParamsReportParamReportTokenReportParamsParams added in v0.16.0

type TokenReportParamsReportParamReportTokenReportParamsParams struct {
	// The address of the token to report on.
	Address param.Field[string] `json:"address,required"`
	// The chain name
	Chain param.Field[TokenScanSupportedChain] `json:"chain,required"`
}

func (TokenReportParamsReportParamReportTokenReportParamsParams) MarshalJSON added in v0.16.0

type TokenReportParamsReportParamReportTokenReportParamsType added in v0.16.0

type TokenReportParamsReportParamReportTokenReportParamsType string
const (
	TokenReportParamsReportParamReportTokenReportParamsTypeParams TokenReportParamsReportParamReportTokenReportParamsType = "params"
)

func (TokenReportParamsReportParamReportTokenReportParamsType) IsKnown added in v0.16.0

type TokenReportParamsReportRequestIDReport added in v0.15.0

type TokenReportParamsReportRequestIDReport struct {
	RequestID param.Field[string]                                     `json:"request_id,required"`
	Type      param.Field[TokenReportParamsReportRequestIDReportType] `json:"type,required"`
}

func (TokenReportParamsReportRequestIDReport) MarshalJSON added in v0.15.0

func (r TokenReportParamsReportRequestIDReport) MarshalJSON() (data []byte, err error)

type TokenReportParamsReportRequestIDReportType added in v0.15.0

type TokenReportParamsReportRequestIDReportType string
const (
	TokenReportParamsReportRequestIDReportTypeRequestID TokenReportParamsReportRequestIDReportType = "request_id"
)

func (TokenReportParamsReportRequestIDReportType) IsKnown added in v0.15.0

type TokenReportParamsReportType added in v0.15.0

type TokenReportParamsReportType string
const (
	TokenReportParamsReportTypeParams    TokenReportParamsReportType = "params"
	TokenReportParamsReportTypeRequestID TokenReportParamsReportType = "request_id"
)

func (TokenReportParamsReportType) IsKnown added in v0.15.0

func (r TokenReportParamsReportType) IsKnown() bool

type TokenReportParamsReportUnion added in v0.15.0

type TokenReportParamsReportUnion interface {
	// contains filtered or unexported methods
}

The report parameters.

Satisfied by TokenReportParamsReportParamReportTokenReportParams, TokenReportParamsReportRequestIDReport, TokenReportParamsReport.

type TokenReportResponse added in v0.15.0

type TokenReportResponse = interface{}

type TokenScanParams added in v0.7.6

type TokenScanParams struct {
	// Token address to validate (EVM / Solana / Stellar / Starknet)
	Address param.Field[string] `json:"address,required"`
	// The chain name
	Chain param.Field[TokenScanSupportedChain] `json:"chain,required"`
	// Object of additional information to validate against.
	Metadata param.Field[TokenScanParamsMetadata] `json:"metadata"`
}

func (TokenScanParams) MarshalJSON added in v0.7.6

func (r TokenScanParams) MarshalJSON() (data []byte, err error)

type TokenScanParamsMetadata added in v0.7.6

type TokenScanParamsMetadata struct {
	// cross reference transaction against the domain.
	Domain param.Field[string] `json:"domain"`
}

Object of additional information to validate against.

func (TokenScanParamsMetadata) MarshalJSON added in v0.7.6

func (r TokenScanParamsMetadata) MarshalJSON() (data []byte, err error)

type TokenScanResponse added in v0.7.6

type TokenScanResponse struct {
	// Token address to validate (EVM / Solana)
	Address string `json:"address,required"`
	// Dictionary of detected attacks found during the scan
	AttackTypes map[string]TokenScanResponseAttackType `json:"attack_types,required"`
	// The chain name
	Chain TokenScanSupportedChain `json:"chain,required"`
	// Fees associated with the token
	Fees TokenScanResponseFees `json:"fees,required"`
	// financial stats of the token
	FinancialStats TokenScanResponseFinancialStats `json:"financial_stats,required"`
	// Score between 0 to 1 (double)
	MaliciousScore string `json:"malicious_score,required"`
	// Metadata of the token
	Metadata TokenScanResponseMetadata `json:"metadata,required"`
	// An enumeration.
	ResultType TokenScanResponseResultType `json:"result_type,required"`
	// Trading limits of the token
	TradingLimits TokenScanResponseTradingLimits `json:"trading_limits,required"`
	// List of features associated with the token
	Features []TokenScanResponseFeature `json:"features"`
	JSON     tokenScanResponseJSON      `json:"-"`
}

func (*TokenScanResponse) UnmarshalJSON added in v0.7.6

func (r *TokenScanResponse) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseAttackType added in v0.7.6

type TokenScanResponseAttackType struct {
	// Score between 0 to 1 (double) that indicates the assurance this attack happened
	Score string `json:"score,required"`
	// Object contains an extra information related to the attack
	Features interface{} `json:"features"`
	// If score is higher or equal to this field, the token is using this attack type
	Threshold string                          `json:"threshold"`
	JSON      tokenScanResponseAttackTypeJSON `json:"-"`
}

func (*TokenScanResponseAttackType) UnmarshalJSON added in v0.7.6

func (r *TokenScanResponseAttackType) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseFeature added in v0.22.1

type TokenScanResponseFeature struct {
	// Description of the feature
	Description string `json:"description,required"`
	// An enumeration.
	FeatureID TokenScanResponseFeaturesFeatureID `json:"feature_id,required"`
	// An enumeration.
	Type TokenScanResponseFeaturesType `json:"type,required"`
	JSON tokenScanResponseFeatureJSON  `json:"-"`
}

func (*TokenScanResponseFeature) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseFeature) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseFeaturesFeatureID added in v0.22.1

type TokenScanResponseFeaturesFeatureID string

An enumeration.

const (
	TokenScanResponseFeaturesFeatureIDVerifiedContract               TokenScanResponseFeaturesFeatureID = "VERIFIED_CONTRACT"
	TokenScanResponseFeaturesFeatureIDHighTradeVolume                TokenScanResponseFeaturesFeatureID = "HIGH_TRADE_VOLUME"
	TokenScanResponseFeaturesFeatureIDMarketPlaceSalesHistory        TokenScanResponseFeaturesFeatureID = "MARKET_PLACE_SALES_HISTORY"
	TokenScanResponseFeaturesFeatureIDHighReputationToken            TokenScanResponseFeaturesFeatureID = "HIGH_REPUTATION_TOKEN"
	TokenScanResponseFeaturesFeatureIDOnchainActivityValidator       TokenScanResponseFeaturesFeatureID = "ONCHAIN_ACTIVITY_VALIDATOR"
	TokenScanResponseFeaturesFeatureIDStaticCodeSignature            TokenScanResponseFeaturesFeatureID = "STATIC_CODE_SIGNATURE"
	TokenScanResponseFeaturesFeatureIDKnownMalicious                 TokenScanResponseFeaturesFeatureID = "KNOWN_MALICIOUS"
	TokenScanResponseFeaturesFeatureIDMetadata                       TokenScanResponseFeaturesFeatureID = "METADATA"
	TokenScanResponseFeaturesFeatureIDAirdropPattern                 TokenScanResponseFeaturesFeatureID = "AIRDROP_PATTERN"
	TokenScanResponseFeaturesFeatureIDImpersonator                   TokenScanResponseFeaturesFeatureID = "IMPERSONATOR"
	TokenScanResponseFeaturesFeatureIDInorganicVolume                TokenScanResponseFeaturesFeatureID = "INORGANIC_VOLUME"
	TokenScanResponseFeaturesFeatureIDDynamicAnalysis                TokenScanResponseFeaturesFeatureID = "DYNAMIC_ANALYSIS"
	TokenScanResponseFeaturesFeatureIDUnstableTokenPrice             TokenScanResponseFeaturesFeatureID = "UNSTABLE_TOKEN_PRICE"
	TokenScanResponseFeaturesFeatureIDRugpull                        TokenScanResponseFeaturesFeatureID = "RUGPULL"
	TokenScanResponseFeaturesFeatureIDConsumerOverride               TokenScanResponseFeaturesFeatureID = "CONSUMER_OVERRIDE"
	TokenScanResponseFeaturesFeatureIDInappropriateContent           TokenScanResponseFeaturesFeatureID = "INAPPROPRIATE_CONTENT"
	TokenScanResponseFeaturesFeatureIDHighTransferFee                TokenScanResponseFeaturesFeatureID = "HIGH_TRANSFER_FEE"
	TokenScanResponseFeaturesFeatureIDHighBuyFee                     TokenScanResponseFeaturesFeatureID = "HIGH_BUY_FEE"
	TokenScanResponseFeaturesFeatureIDHighSellFee                    TokenScanResponseFeaturesFeatureID = "HIGH_SELL_FEE"
	TokenScanResponseFeaturesFeatureIDIsMintable                     TokenScanResponseFeaturesFeatureID = "IS_MINTABLE"
	TokenScanResponseFeaturesFeatureIDModifiableTaxes                TokenScanResponseFeaturesFeatureID = "MODIFIABLE_TAXES"
	TokenScanResponseFeaturesFeatureIDCanBlacklist                   TokenScanResponseFeaturesFeatureID = "CAN_BLACKLIST"
	TokenScanResponseFeaturesFeatureIDCanWhitelist                   TokenScanResponseFeaturesFeatureID = "CAN_WHITELIST"
	TokenScanResponseFeaturesFeatureIDHasTradingCooldown             TokenScanResponseFeaturesFeatureID = "HAS_TRADING_COOLDOWN"
	TokenScanResponseFeaturesFeatureIDExternalFunctions              TokenScanResponseFeaturesFeatureID = "EXTERNAL_FUNCTIONS"
	TokenScanResponseFeaturesFeatureIDHiddenOwner                    TokenScanResponseFeaturesFeatureID = "HIDDEN_OWNER"
	TokenScanResponseFeaturesFeatureIDTransferPauseable              TokenScanResponseFeaturesFeatureID = "TRANSFER_PAUSEABLE"
	TokenScanResponseFeaturesFeatureIDOwnershipRenounced             TokenScanResponseFeaturesFeatureID = "OWNERSHIP_RENOUNCED"
	TokenScanResponseFeaturesFeatureIDProxyContract                  TokenScanResponseFeaturesFeatureID = "PROXY_CONTRACT"
	TokenScanResponseFeaturesFeatureIDLiquidStake                    TokenScanResponseFeaturesFeatureID = "LIQUID_STAKE"
	TokenScanResponseFeaturesFeatureIDRebaseToken                    TokenScanResponseFeaturesFeatureID = "REBASE_TOKEN"
	TokenScanResponseFeaturesFeatureIDUnsellableToken                TokenScanResponseFeaturesFeatureID = "UNSELLABLE_TOKEN"
	TokenScanResponseFeaturesFeatureIDConcentratedSupplyDistribution TokenScanResponseFeaturesFeatureID = "CONCENTRATED_SUPPLY_DISTRIBUTION"
	TokenScanResponseFeaturesFeatureIDInsufficientLockedLiquidity    TokenScanResponseFeaturesFeatureID = "INSUFFICIENT_LOCKED_LIQUIDITY"
	TokenScanResponseFeaturesFeatureIDHoneypot                       TokenScanResponseFeaturesFeatureID = "HONEYPOT"
)

func (TokenScanResponseFeaturesFeatureID) IsKnown added in v0.22.1

type TokenScanResponseFeaturesType added in v0.22.1

type TokenScanResponseFeaturesType string

An enumeration.

const (
	TokenScanResponseFeaturesTypeBenign    TokenScanResponseFeaturesType = "Benign"
	TokenScanResponseFeaturesTypeInfo      TokenScanResponseFeaturesType = "Info"
	TokenScanResponseFeaturesTypeWarning   TokenScanResponseFeaturesType = "Warning"
	TokenScanResponseFeaturesTypeMalicious TokenScanResponseFeaturesType = "Malicious"
)

func (TokenScanResponseFeaturesType) IsKnown added in v0.22.1

func (r TokenScanResponseFeaturesType) IsKnown() bool

type TokenScanResponseFees added in v0.22.1

type TokenScanResponseFees struct {
	// Buy fee of the token
	Buy float64 `json:"buy"`
	// Sell fee of the token
	Sell float64 `json:"sell"`
	// Transfer fee of the token
	Transfer float64                   `json:"transfer"`
	JSON     tokenScanResponseFeesJSON `json:"-"`
}

Fees associated with the token

func (*TokenScanResponseFees) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseFees) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseFinancialStats added in v0.22.1

type TokenScanResponseFinancialStats struct {
	BurnedLiquidityPercentage float64                                    `json:"burned_liquidity_percentage"`
	HoldersCount              int64                                      `json:"holders_count"`
	LockedLiquidityPercentage float64                                    `json:"locked_liquidity_percentage"`
	TopHolders                []TokenScanResponseFinancialStatsTopHolder `json:"top_holders"`
	UsdPricePerUnit           float64                                    `json:"usd_price_per_unit"`
	JSON                      tokenScanResponseFinancialStatsJSON        `json:"-"`
}

financial stats of the token

func (*TokenScanResponseFinancialStats) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseFinancialStats) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseFinancialStatsTopHolder added in v0.22.1

type TokenScanResponseFinancialStatsTopHolder struct {
	Address           string                                       `json:"address"`
	HoldingPercentage float64                                      `json:"holding_percentage"`
	JSON              tokenScanResponseFinancialStatsTopHolderJSON `json:"-"`
}

func (*TokenScanResponseFinancialStatsTopHolder) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseFinancialStatsTopHolder) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadata added in v0.22.1

type TokenScanResponseMetadata struct {
	// The unique ID for the Rune
	ID string `json:"id"`
	// This field can have the runtime type of
	// [TokenScanResponseMetadataSolanaMetadataContractBalance],
	// [TokenScanResponseMetadataEvmMetadataTokenContractBalance].
	ContractBalance interface{} `json:"contract_balance"`
	// Contract deploy date
	CreationTimestamp time.Time `json:"creation_timestamp" format:"date-time"`
	// Address of the deployer of the fungible token
	Deployer string `json:"deployer"`
	// Description of the token
	Description string `json:"description"`
	// This field can have the runtime type of
	// [TokenScanResponseMetadataSolanaMetadataExternalLinks],
	// [TokenScanResponseMetadataEvmMetadataTokenExternalLinks].
	ExternalLinks interface{} `json:"external_links"`
	// The formatted name of the rune, with spacers
	FormattedName string `json:"formatted_name"`
	// Solana token freeze authority account
	FreezeAuthority string `json:"freeze_authority"`
	// URL of the token image
	ImageURL string `json:"image_url"`
	// Solana token mint authority account
	MintAuthority string `json:"mint_authority"`
	// Name of the token
	Name string `json:"name"`
	// The rune's unique sequential number.
	Number int64 `json:"number"`
	// Contract owner address
	Owner string `json:"owner"`
	// This field can have the runtime type of
	// [TokenScanResponseMetadataSolanaMetadataOwnerBalance],
	// [TokenScanResponseMetadataEvmMetadataTokenOwnerBalance].
	OwnerBalance interface{} `json:"owner_balance"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string `json:"type"`
	// Solana token update authority account
	UpdateAuthority string                        `json:"update_authority"`
	JSON            tokenScanResponseMetadataJSON `json:"-"`
	// contains filtered or unexported fields
}

Metadata of the token

func (TokenScanResponseMetadata) AsUnion added in v0.22.1

AsUnion returns a TokenScanResponseMetadataUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TokenScanResponseMetadataSolanaMetadata, TokenScanResponseMetadataBitcoinMetadataToken, TokenScanResponseMetadataEvmMetadataToken.

func (*TokenScanResponseMetadata) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseMetadata) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataBitcoinMetadataToken added in v0.27.0

type TokenScanResponseMetadataBitcoinMetadataToken struct {
	// The unique ID for the Rune
	ID string `json:"id"`
	// The formatted name of the rune, with spacers
	FormattedName string `json:"formatted_name"`
	// Name of the token
	Name string `json:"name"`
	// The rune's unique sequential number.
	Number int64 `json:"number"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string                                            `json:"type"`
	JSON tokenScanResponseMetadataBitcoinMetadataTokenJSON `json:"-"`
}

func (*TokenScanResponseMetadataBitcoinMetadataToken) UnmarshalJSON added in v0.27.0

func (r *TokenScanResponseMetadataBitcoinMetadataToken) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataEvmMetadataToken added in v0.27.0

type TokenScanResponseMetadataEvmMetadataToken struct {
	// Contract balance
	ContractBalance TokenScanResponseMetadataEvmMetadataTokenContractBalance `json:"contract_balance"`
	// Contract deploy date
	CreationTimestamp time.Time `json:"creation_timestamp" format:"date-time"`
	// Address of the deployer of the fungible token
	Deployer string `json:"deployer"`
	// Description of the token
	Description string `json:"description"`
	// social links of the token
	ExternalLinks TokenScanResponseMetadataEvmMetadataTokenExternalLinks `json:"external_links"`
	// URL of the token image
	ImageURL string `json:"image_url"`
	// Name of the token
	Name string `json:"name"`
	// Contract owner address
	Owner string `json:"owner"`
	// Contract owner balance
	OwnerBalance TokenScanResponseMetadataEvmMetadataTokenOwnerBalance `json:"owner_balance"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string                                        `json:"type"`
	JSON tokenScanResponseMetadataEvmMetadataTokenJSON `json:"-"`
}

func (*TokenScanResponseMetadataEvmMetadataToken) UnmarshalJSON added in v0.27.0

func (r *TokenScanResponseMetadataEvmMetadataToken) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataEvmMetadataTokenContractBalance added in v0.27.0

type TokenScanResponseMetadataEvmMetadataTokenContractBalance struct {
	Amount    float64                                                      `json:"amount"`
	AmountWei string                                                       `json:"amount_wei"`
	JSON      tokenScanResponseMetadataEvmMetadataTokenContractBalanceJSON `json:"-"`
}

Contract balance

func (*TokenScanResponseMetadataEvmMetadataTokenContractBalance) UnmarshalJSON added in v0.27.0

type TokenScanResponseMetadataEvmMetadataTokenExternalLinks struct {
	Homepage          string                                                     `json:"homepage"`
	TelegramChannelID string                                                     `json:"telegram_channel_id"`
	TwitterPage       string                                                     `json:"twitter_page"`
	JSON              tokenScanResponseMetadataEvmMetadataTokenExternalLinksJSON `json:"-"`
}

social links of the token

func (*TokenScanResponseMetadataEvmMetadataTokenExternalLinks) UnmarshalJSON added in v0.27.0

func (r *TokenScanResponseMetadataEvmMetadataTokenExternalLinks) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataEvmMetadataTokenOwnerBalance added in v0.27.0

type TokenScanResponseMetadataEvmMetadataTokenOwnerBalance struct {
	Amount    float64                                                   `json:"amount"`
	AmountWei string                                                    `json:"amount_wei"`
	JSON      tokenScanResponseMetadataEvmMetadataTokenOwnerBalanceJSON `json:"-"`
}

Contract owner balance

func (*TokenScanResponseMetadataEvmMetadataTokenOwnerBalance) UnmarshalJSON added in v0.27.0

func (r *TokenScanResponseMetadataEvmMetadataTokenOwnerBalance) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataSolanaMetadata added in v0.22.1

type TokenScanResponseMetadataSolanaMetadata struct {
	// Contract balance
	ContractBalance TokenScanResponseMetadataSolanaMetadataContractBalance `json:"contract_balance"`
	// Contract deploy date
	CreationTimestamp time.Time `json:"creation_timestamp" format:"date-time"`
	// Address of the deployer of the fungible token
	Deployer string `json:"deployer"`
	// Description of the token
	Description string `json:"description"`
	// social links of the token
	ExternalLinks TokenScanResponseMetadataSolanaMetadataExternalLinks `json:"external_links"`
	// Solana token freeze authority account
	FreezeAuthority string `json:"freeze_authority"`
	// URL of the token image
	ImageURL string `json:"image_url"`
	// Solana token mint authority account
	MintAuthority string `json:"mint_authority"`
	// Name of the token
	Name string `json:"name"`
	// Contract owner address
	Owner string `json:"owner"`
	// Contract owner balance
	OwnerBalance TokenScanResponseMetadataSolanaMetadataOwnerBalance `json:"owner_balance"`
	// Symbol of the token
	Symbol string `json:"symbol"`
	// Type of the token
	Type string `json:"type"`
	// Solana token update authority account
	UpdateAuthority string                                      `json:"update_authority"`
	JSON            tokenScanResponseMetadataSolanaMetadataJSON `json:"-"`
}

func (*TokenScanResponseMetadataSolanaMetadata) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseMetadataSolanaMetadata) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataSolanaMetadataContractBalance added in v0.27.0

type TokenScanResponseMetadataSolanaMetadataContractBalance struct {
	Amount    float64                                                    `json:"amount"`
	AmountWei string                                                     `json:"amount_wei"`
	JSON      tokenScanResponseMetadataSolanaMetadataContractBalanceJSON `json:"-"`
}

Contract balance

func (*TokenScanResponseMetadataSolanaMetadataContractBalance) UnmarshalJSON added in v0.27.0

func (r *TokenScanResponseMetadataSolanaMetadataContractBalance) UnmarshalJSON(data []byte) (err error)
type TokenScanResponseMetadataSolanaMetadataExternalLinks struct {
	Homepage          string                                                   `json:"homepage"`
	TelegramChannelID string                                                   `json:"telegram_channel_id"`
	TwitterPage       string                                                   `json:"twitter_page"`
	JSON              tokenScanResponseMetadataSolanaMetadataExternalLinksJSON `json:"-"`
}

social links of the token

func (*TokenScanResponseMetadataSolanaMetadataExternalLinks) UnmarshalJSON added in v0.27.0

func (r *TokenScanResponseMetadataSolanaMetadataExternalLinks) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataSolanaMetadataOwnerBalance added in v0.27.0

type TokenScanResponseMetadataSolanaMetadataOwnerBalance struct {
	Amount    float64                                                 `json:"amount"`
	AmountWei string                                                  `json:"amount_wei"`
	JSON      tokenScanResponseMetadataSolanaMetadataOwnerBalanceJSON `json:"-"`
}

Contract owner balance

func (*TokenScanResponseMetadataSolanaMetadataOwnerBalance) UnmarshalJSON added in v0.27.0

func (r *TokenScanResponseMetadataSolanaMetadataOwnerBalance) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseMetadataUnion added in v0.22.1

type TokenScanResponseMetadataUnion interface {
	// contains filtered or unexported methods
}

Metadata of the token

Union satisfied by TokenScanResponseMetadataSolanaMetadata, TokenScanResponseMetadataBitcoinMetadataToken or TokenScanResponseMetadataEvmMetadataToken.

type TokenScanResponseResultType added in v0.7.6

type TokenScanResponseResultType string

An enumeration.

const (
	TokenScanResponseResultTypeBenign    TokenScanResponseResultType = "Benign"
	TokenScanResponseResultTypeWarning   TokenScanResponseResultType = "Warning"
	TokenScanResponseResultTypeMalicious TokenScanResponseResultType = "Malicious"
	TokenScanResponseResultTypeSpam      TokenScanResponseResultType = "Spam"
)

func (TokenScanResponseResultType) IsKnown added in v0.7.6

func (r TokenScanResponseResultType) IsKnown() bool

type TokenScanResponseTradingLimits added in v0.22.1

type TokenScanResponseTradingLimits struct {
	MaxBuy            TokenScanResponseTradingLimitsMaxBuy            `json:"max_buy"`
	MaxHolding        TokenScanResponseTradingLimitsMaxHolding        `json:"max_holding"`
	MaxSell           TokenScanResponseTradingLimitsMaxSell           `json:"max_sell"`
	SellLimitPerBlock TokenScanResponseTradingLimitsSellLimitPerBlock `json:"sell_limit_per_block"`
	JSON              tokenScanResponseTradingLimitsJSON              `json:"-"`
}

Trading limits of the token

func (*TokenScanResponseTradingLimits) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseTradingLimits) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseTradingLimitsMaxBuy added in v0.22.1

type TokenScanResponseTradingLimitsMaxBuy struct {
	Amount    float64                                  `json:"amount"`
	AmountWei string                                   `json:"amount_wei"`
	JSON      tokenScanResponseTradingLimitsMaxBuyJSON `json:"-"`
}

func (*TokenScanResponseTradingLimitsMaxBuy) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseTradingLimitsMaxBuy) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseTradingLimitsMaxHolding added in v0.22.1

type TokenScanResponseTradingLimitsMaxHolding struct {
	Amount    float64                                      `json:"amount"`
	AmountWei string                                       `json:"amount_wei"`
	JSON      tokenScanResponseTradingLimitsMaxHoldingJSON `json:"-"`
}

func (*TokenScanResponseTradingLimitsMaxHolding) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseTradingLimitsMaxHolding) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseTradingLimitsMaxSell added in v0.22.1

type TokenScanResponseTradingLimitsMaxSell struct {
	Amount    float64                                   `json:"amount"`
	AmountWei string                                    `json:"amount_wei"`
	JSON      tokenScanResponseTradingLimitsMaxSellJSON `json:"-"`
}

func (*TokenScanResponseTradingLimitsMaxSell) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseTradingLimitsMaxSell) UnmarshalJSON(data []byte) (err error)

type TokenScanResponseTradingLimitsSellLimitPerBlock added in v0.22.1

type TokenScanResponseTradingLimitsSellLimitPerBlock struct {
	Amount    float64                                             `json:"amount"`
	AmountWei string                                              `json:"amount_wei"`
	JSON      tokenScanResponseTradingLimitsSellLimitPerBlockJSON `json:"-"`
}

func (*TokenScanResponseTradingLimitsSellLimitPerBlock) UnmarshalJSON added in v0.22.1

func (r *TokenScanResponseTradingLimitsSellLimitPerBlock) UnmarshalJSON(data []byte) (err error)

type TokenScanSupportedChain added in v0.7.6

type TokenScanSupportedChain string

The chain name

const (
	TokenScanSupportedChainArbitrum  TokenScanSupportedChain = "arbitrum"
	TokenScanSupportedChainAvalanche TokenScanSupportedChain = "avalanche"
	TokenScanSupportedChainBase      TokenScanSupportedChain = "base"
	TokenScanSupportedChainBsc       TokenScanSupportedChain = "bsc"
	TokenScanSupportedChainEthereum  TokenScanSupportedChain = "ethereum"
	TokenScanSupportedChainOptimism  TokenScanSupportedChain = "optimism"
	TokenScanSupportedChainPolygon   TokenScanSupportedChain = "polygon"
	TokenScanSupportedChainZora      TokenScanSupportedChain = "zora"
	TokenScanSupportedChainSolana    TokenScanSupportedChain = "solana"
	TokenScanSupportedChainStarknet  TokenScanSupportedChain = "starknet"
	TokenScanSupportedChainStellar   TokenScanSupportedChain = "stellar"
	TokenScanSupportedChainLinea     TokenScanSupportedChain = "linea"
	TokenScanSupportedChainBlast     TokenScanSupportedChain = "blast"
	TokenScanSupportedChainZksync    TokenScanSupportedChain = "zksync"
	TokenScanSupportedChainScroll    TokenScanSupportedChain = "scroll"
	TokenScanSupportedChainDegen     TokenScanSupportedChain = "degen"
)

func (TokenScanSupportedChain) IsKnown added in v0.7.6

func (r TokenScanSupportedChain) IsKnown() bool

type TokenService added in v0.7.6

type TokenService struct {
	Options []option.RequestOption
}

TokenService contains methods and other services that help with interacting with the blockaid API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewTokenService method instead.

func NewTokenService added in v0.7.6

func NewTokenService(opts ...option.RequestOption) (r *TokenService)

NewTokenService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*TokenService) Report added in v0.15.0

func (r *TokenService) Report(ctx context.Context, body TokenReportParams, opts ...option.RequestOption) (res *TokenReportResponse, err error)

Report for misclassification of a token.

func (*TokenService) Scan added in v0.7.6

func (r *TokenService) Scan(ctx context.Context, body TokenScanParams, opts ...option.RequestOption) (res *TokenScanResponse, err error)

Gets a token address and scan the token to identify any indication of malicious behaviour

type TotalUsdDiffSchema added in v0.12.0

type TotalUsdDiffSchema struct {
	// Total incoming USD transfers
	In float64 `json:"in,required"`
	// Total outgoing USD transfers
	Out float64 `json:"out,required"`
	// Total USD transfers
	Total float64                `json:"total,required"`
	JSON  totalUsdDiffSchemaJSON `json:"-"`
}

func (*TotalUsdDiffSchema) UnmarshalJSON added in v0.12.0

func (r *TotalUsdDiffSchema) UnmarshalJSON(data []byte) (err error)

type TransactionErrorDetails added in v0.22.1

type TransactionErrorDetails struct {
	// Human readable error
	Message string `json:"message,required"`
	// Index of the transaction in the bulk
	TransactionIndex int64 `json:"transaction_index,required"`
	// Machine readable error code
	Code string `json:"code,nullable"`
	// Error number
	Number int64                       `json:"number,nullable"`
	Type   string                      `json:"type"`
	JSON   transactionErrorDetailsJSON `json:"-"`
}

func (*TransactionErrorDetails) UnmarshalJSON added in v0.22.1

func (r *TransactionErrorDetails) UnmarshalJSON(data []byte) (err error)

type TransactionScanFeature

type TransactionScanFeature struct {
	// Textual description
	Description string `json:"description,required"`
	// Feature name
	FeatureID string `json:"feature_id,required"`
	// An enumeration.
	Type TransactionScanFeatureType `json:"type,required"`
	// Address the feature refers to
	Address string                     `json:"address"`
	JSON    transactionScanFeatureJSON `json:"-"`
}

func (*TransactionScanFeature) UnmarshalJSON

func (r *TransactionScanFeature) UnmarshalJSON(data []byte) (err error)

type TransactionScanFeatureType

type TransactionScanFeatureType string

An enumeration.

const (
	TransactionScanFeatureTypeMalicious TransactionScanFeatureType = "Malicious"
	TransactionScanFeatureTypeWarning   TransactionScanFeatureType = "Warning"
	TransactionScanFeatureTypeBenign    TransactionScanFeatureType = "Benign"
	TransactionScanFeatureTypeInfo      TransactionScanFeatureType = "Info"
)

func (TransactionScanFeatureType) IsKnown

func (r TransactionScanFeatureType) IsKnown() bool

type TransactionScanResponse

type TransactionScanResponse struct {
	Block          string                               `json:"block,required"`
	Chain          string                               `json:"chain,required"`
	AccountAddress string                               `json:"account_address"`
	Events         []TransactionScanResponseEvent       `json:"events"`
	Features       interface{}                          `json:"features"`
	GasEstimation  TransactionScanResponseGasEstimation `json:"gas_estimation"`
	Simulation     TransactionScanResponseSimulation    `json:"simulation"`
	Validation     TransactionScanResponseValidation    `json:"validation"`
	JSON           transactionScanResponseJSON          `json:"-"`
}

func (*TransactionScanResponse) UnmarshalJSON

func (r *TransactionScanResponse) UnmarshalJSON(data []byte) (err error)

type TransactionScanResponseEvent added in v0.7.5

type TransactionScanResponseEvent struct {
	Data           string                               `json:"data,required"`
	EmitterAddress string                               `json:"emitter_address,required"`
	Topics         []string                             `json:"topics,required"`
	EmitterName    string                               `json:"emitter_name"`
	Name           string                               `json:"name"`
	Params         []TransactionScanResponseEventsParam `json:"params"`
	JSON           transactionScanResponseEventJSON     `json:"-"`
}

func (*TransactionScanResponseEvent) UnmarshalJSON added in v0.7.5

func (r *TransactionScanResponseEvent) UnmarshalJSON(data []byte) (err error)

type TransactionScanResponseEventsParam added in v0.7.5

type TransactionScanResponseEventsParam struct {
	Type         string                                        `json:"type,required"`
	Value        TransactionScanResponseEventsParamsValueUnion `json:"value,required"`
	InternalType string                                        `json:"internalType"`
	Name         string                                        `json:"name"`
	JSON         transactionScanResponseEventsParamJSON        `json:"-"`
}

func (*TransactionScanResponseEventsParam) UnmarshalJSON added in v0.7.5

func (r *TransactionScanResponseEventsParam) UnmarshalJSON(data []byte) (err error)

type TransactionScanResponseEventsParamsValueArray added in v0.7.5

type TransactionScanResponseEventsParamsValueArray []interface{}

func (TransactionScanResponseEventsParamsValueArray) ImplementsTransactionScanResponseEventsParamsValueUnion added in v0.7.5

func (r TransactionScanResponseEventsParamsValueArray) ImplementsTransactionScanResponseEventsParamsValueUnion()

type TransactionScanResponseEventsParamsValueUnion added in v0.7.5

type TransactionScanResponseEventsParamsValueUnion interface {
	ImplementsTransactionScanResponseEventsParamsValueUnion()
}

Union satisfied by shared.UnionString or TransactionScanResponseEventsParamsValueArray.

type TransactionScanResponseGasEstimation added in v0.7.5

type TransactionScanResponseGasEstimation struct {
	Status   TransactionScanResponseGasEstimationStatus `json:"status,required"`
	Error    string                                     `json:"error"`
	Estimate int64                                      `json:"estimate"`
	Used     int64                                      `json:"used"`
	JSON     transactionScanResponseGasEstimationJSON   `json:"-"`
	// contains filtered or unexported fields
}

func (TransactionScanResponseGasEstimation) AsUnion added in v0.7.5

AsUnion returns a TransactionScanResponseGasEstimationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionScanResponseGasEstimationTransactionScanGasEstimation, TransactionScanResponseGasEstimationTransactionScanGasEstimationError.

func (*TransactionScanResponseGasEstimation) UnmarshalJSON added in v0.7.5

func (r *TransactionScanResponseGasEstimation) UnmarshalJSON(data []byte) (err error)

type TransactionScanResponseGasEstimationStatus added in v0.8.0

type TransactionScanResponseGasEstimationStatus string
const (
	TransactionScanResponseGasEstimationStatusSuccess TransactionScanResponseGasEstimationStatus = "Success"
	TransactionScanResponseGasEstimationStatusError   TransactionScanResponseGasEstimationStatus = "Error"
)

func (TransactionScanResponseGasEstimationStatus) IsKnown added in v0.8.0

type TransactionScanResponseGasEstimationTransactionScanGasEstimation added in v0.7.5

type TransactionScanResponseGasEstimationTransactionScanGasEstimation struct {
	Estimate int64                                                                  `json:"estimate,required"`
	Status   TransactionScanResponseGasEstimationTransactionScanGasEstimationStatus `json:"status,required"`
	Used     int64                                                                  `json:"used,required"`
	JSON     transactionScanResponseGasEstimationTransactionScanGasEstimationJSON   `json:"-"`
}

func (*TransactionScanResponseGasEstimationTransactionScanGasEstimation) UnmarshalJSON added in v0.7.5

type TransactionScanResponseGasEstimationTransactionScanGasEstimationError added in v0.7.5

type TransactionScanResponseGasEstimationTransactionScanGasEstimationError struct {
	Error  string                                                                      `json:"error,required"`
	Status TransactionScanResponseGasEstimationTransactionScanGasEstimationErrorStatus `json:"status,required"`
	JSON   transactionScanResponseGasEstimationTransactionScanGasEstimationErrorJSON   `json:"-"`
}

func (*TransactionScanResponseGasEstimationTransactionScanGasEstimationError) UnmarshalJSON added in v0.7.5

type TransactionScanResponseGasEstimationTransactionScanGasEstimationErrorStatus added in v0.8.0

type TransactionScanResponseGasEstimationTransactionScanGasEstimationErrorStatus string
const (
	TransactionScanResponseGasEstimationTransactionScanGasEstimationErrorStatusError TransactionScanResponseGasEstimationTransactionScanGasEstimationErrorStatus = "Error"
)

func (TransactionScanResponseGasEstimationTransactionScanGasEstimationErrorStatus) IsKnown added in v0.8.0

type TransactionScanResponseGasEstimationTransactionScanGasEstimationStatus added in v0.8.0

type TransactionScanResponseGasEstimationTransactionScanGasEstimationStatus string
const (
	TransactionScanResponseGasEstimationTransactionScanGasEstimationStatusSuccess TransactionScanResponseGasEstimationTransactionScanGasEstimationStatus = "Success"
)

func (TransactionScanResponseGasEstimationTransactionScanGasEstimationStatus) IsKnown added in v0.8.0

type TransactionScanResponseGasEstimationUnion added in v0.7.5

type TransactionScanResponseGasEstimationUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by TransactionScanResponseGasEstimationTransactionScanGasEstimation or TransactionScanResponseGasEstimationTransactionScanGasEstimationError.

type TransactionScanResponseSimulation

type TransactionScanResponseSimulation struct {
	// A string indicating if the simulation was successful or not.
	Status TransactionScanResponseSimulationStatus `json:"status,required"`
	// This field can have the runtime type of [TransactionSimulationAccountSummary].
	AccountSummary interface{} `json:"account_summary"`
	// This field can have the runtime type of
	// [map[string]TransactionSimulationAddressDetail].
	AddressDetails interface{} `json:"address_details"`
	// This field can have the runtime type of
	// [map[string][]TransactionSimulationAssetsDiff].
	AssetsDiffs interface{} `json:"assets_diffs"`
	// This field can have the runtime type of
	// [map[string][]TransactionSimulationContractManagement].
	ContractManagement interface{} `json:"contract_management"`
	// An error message if the simulation failed.
	Error string `json:"error"`
	// This field can have the runtime type of
	// [TransactionSimulationErrorErrorDetails].
	ErrorDetails interface{} `json:"error_details"`
	// This field can have the runtime type of
	// [map[string][]TransactionSimulationExposure].
	Exposures interface{} `json:"exposures"`
	// This field can have the runtime type of [TransactionSimulationParams].
	Params interface{} `json:"params"`
	// This field can have the runtime type of [map[string]UsdDiff].
	TotalUsdDiff interface{} `json:"total_usd_diff"`
	// This field can have the runtime type of [map[string]map[string]string].
	TotalUsdExposure interface{}                           `json:"total_usd_exposure"`
	JSON             transactionScanResponseSimulationJSON `json:"-"`
	// contains filtered or unexported fields
}

func (TransactionScanResponseSimulation) AsUnion

AsUnion returns a TransactionScanResponseSimulationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionSimulation, TransactionSimulationError.

func (*TransactionScanResponseSimulation) UnmarshalJSON

func (r *TransactionScanResponseSimulation) UnmarshalJSON(data []byte) (err error)

type TransactionScanResponseSimulationStatus added in v0.8.0

type TransactionScanResponseSimulationStatus string

A string indicating if the simulation was successful or not.

const (
	TransactionScanResponseSimulationStatusSuccess TransactionScanResponseSimulationStatus = "Success"
	TransactionScanResponseSimulationStatusError   TransactionScanResponseSimulationStatus = "Error"
)

func (TransactionScanResponseSimulationStatus) IsKnown added in v0.8.0

type TransactionScanResponseSimulationUnion

type TransactionScanResponseSimulationUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by TransactionSimulation or TransactionSimulationError.

type TransactionScanResponseValidation

type TransactionScanResponseValidation struct {
	// This field can have the runtime type of [[]TransactionScanFeature].
	Features interface{} `json:"features,required"`
	// An enumeration.
	ResultType TransactionScanResponseValidationResultType `json:"result_type,required"`
	// A string indicating if the simulation was successful or not.
	Status TransactionScanResponseValidationStatus `json:"status,required"`
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification"`
	// A textual description that can be presented to the user about what this
	// transaction is doing.
	Description string `json:"description"`
	// An error message if the validation failed.
	Error string `json:"error"`
	// A textual description about the reasons the transaction was flagged with
	// result_type.
	Reason string                                `json:"reason"`
	JSON   transactionScanResponseValidationJSON `json:"-"`
	// contains filtered or unexported fields
}

func (TransactionScanResponseValidation) AsUnion

AsUnion returns a TransactionScanResponseValidationUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionValidation, TransactionValidationError.

func (*TransactionScanResponseValidation) UnmarshalJSON

func (r *TransactionScanResponseValidation) UnmarshalJSON(data []byte) (err error)

type TransactionScanResponseValidationResultType

type TransactionScanResponseValidationResultType string

An enumeration.

const (
	TransactionScanResponseValidationResultTypeBenign    TransactionScanResponseValidationResultType = "Benign"
	TransactionScanResponseValidationResultTypeWarning   TransactionScanResponseValidationResultType = "Warning"
	TransactionScanResponseValidationResultTypeMalicious TransactionScanResponseValidationResultType = "Malicious"
	TransactionScanResponseValidationResultTypeError     TransactionScanResponseValidationResultType = "Error"
)

func (TransactionScanResponseValidationResultType) IsKnown

type TransactionScanResponseValidationStatus added in v0.9.1

type TransactionScanResponseValidationStatus string

A string indicating if the simulation was successful or not.

const (
	TransactionScanResponseValidationStatusSuccess TransactionScanResponseValidationStatus = "Success"
)

func (TransactionScanResponseValidationStatus) IsKnown added in v0.9.1

type TransactionScanResponseValidationUnion

type TransactionScanResponseValidationUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by TransactionValidation or TransactionValidationError.

type TransactionScanSupportedChain added in v0.7.5

type TransactionScanSupportedChain string

The chain name

const (
	TransactionScanSupportedChainArbitrum              TransactionScanSupportedChain = "arbitrum"
	TransactionScanSupportedChainAvalanche             TransactionScanSupportedChain = "avalanche"
	TransactionScanSupportedChainBase                  TransactionScanSupportedChain = "base"
	TransactionScanSupportedChainBaseSepolia           TransactionScanSupportedChain = "base-sepolia"
	TransactionScanSupportedChainBsc                   TransactionScanSupportedChain = "bsc"
	TransactionScanSupportedChainEthereum              TransactionScanSupportedChain = "ethereum"
	TransactionScanSupportedChainOptimism              TransactionScanSupportedChain = "optimism"
	TransactionScanSupportedChainPolygon               TransactionScanSupportedChain = "polygon"
	TransactionScanSupportedChainZksync                TransactionScanSupportedChain = "zksync"
	TransactionScanSupportedChainZksyncSepolia         TransactionScanSupportedChain = "zksync-sepolia"
	TransactionScanSupportedChainZora                  TransactionScanSupportedChain = "zora"
	TransactionScanSupportedChainLinea                 TransactionScanSupportedChain = "linea"
	TransactionScanSupportedChainBlast                 TransactionScanSupportedChain = "blast"
	TransactionScanSupportedChainScroll                TransactionScanSupportedChain = "scroll"
	TransactionScanSupportedChainEthereumSepolia       TransactionScanSupportedChain = "ethereum-sepolia"
	TransactionScanSupportedChainDegen                 TransactionScanSupportedChain = "degen"
	TransactionScanSupportedChainAvalancheFuji         TransactionScanSupportedChain = "avalanche-fuji"
	TransactionScanSupportedChainImmutableZkevm        TransactionScanSupportedChain = "immutable-zkevm"
	TransactionScanSupportedChainImmutableZkevmTestnet TransactionScanSupportedChain = "immutable-zkevm-testnet"
	TransactionScanSupportedChainGnosis                TransactionScanSupportedChain = "gnosis"
	TransactionScanSupportedChainWorldchain            TransactionScanSupportedChain = "worldchain"
	TransactionScanSupportedChainSoneiumMinato         TransactionScanSupportedChain = "soneium-minato"
	TransactionScanSupportedChainRonin                 TransactionScanSupportedChain = "ronin"
	TransactionScanSupportedChainApechain              TransactionScanSupportedChain = "apechain"
	TransactionScanSupportedChainZeroNetwork           TransactionScanSupportedChain = "zero-network"
	TransactionScanSupportedChainBerachain             TransactionScanSupportedChain = "berachain"
	TransactionScanSupportedChainInk                   TransactionScanSupportedChain = "ink"
	TransactionScanSupportedChainInkSepolia            TransactionScanSupportedChain = "ink-sepolia"
)

func (TransactionScanSupportedChain) IsKnown added in v0.7.5

func (r TransactionScanSupportedChain) IsKnown() bool

type TransactionSimulation

type TransactionSimulation struct {
	// Account summary for the account address. account address is determined implicit
	// by the `from` field in the transaction request, or explicit by the
	// account_address field in the request.
	AccountSummary TransactionSimulationAccountSummary `json:"account_summary,required"`
	// a dictionary including additional information about each relevant address in the
	// transaction.
	AddressDetails map[string]TransactionSimulationAddressDetail `json:"address_details,required"`
	// dictionary describes the assets differences as a result of this transaction for
	// every involved address
	AssetsDiffs map[string][]TransactionSimulationAssetsDiff `json:"assets_diffs,required"`
	// dictionary describes the exposure differences as a result of this transaction
	// for every involved address (as a result of any approval / setApproval / permit
	// function)
	Exposures map[string][]TransactionSimulationExposure `json:"exposures,required"`
	// A string indicating if the simulation was successful or not.
	Status TransactionSimulationStatus `json:"status,required"`
	// dictionary represents the usd value each address gained / lost during this
	// transaction
	TotalUsdDiff map[string]UsdDiff `json:"total_usd_diff,required"`
	// a dictionary representing the usd value each address is exposed to, split by
	// spenders
	TotalUsdExposure map[string]map[string]string `json:"total_usd_exposure,required"`
	// Describes the state differences as a result of this transaction for every
	// involved address
	ContractManagement map[string][]TransactionSimulationContractManagement `json:"contract_management"`
	// The parameters of the transaction that was simulated.
	Params TransactionSimulationParams `json:"params"`
	JSON   transactionSimulationJSON   `json:"-"`
}

func (*TransactionSimulation) UnmarshalJSON

func (r *TransactionSimulation) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAccountSummary

type TransactionSimulationAccountSummary struct {
	// All assets diffs related to the account address
	AssetsDiffs []TransactionSimulationAccountSummaryAssetsDiff `json:"assets_diffs,required"`
	// All assets exposures related to the account address
	Exposures []TransactionSimulationAccountSummaryExposure `json:"exposures,required"`
	// Total usd diff related to the account address
	TotalUsdDiff UsdDiff `json:"total_usd_diff,required"`
	// Total usd exposure related to the account address
	TotalUsdExposure map[string]string `json:"total_usd_exposure,required"`
	// All assets traces related to the account address
	Traces []TransactionSimulationAccountSummaryTrace `json:"traces,required"`
	JSON   transactionSimulationAccountSummaryJSON    `json:"-"`
}

Account summary for the account address. account address is determined implicit by the `from` field in the transaction request, or explicit by the account_address field in the request.

func (*TransactionSimulationAccountSummary) UnmarshalJSON

func (r *TransactionSimulationAccountSummary) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAccountSummaryAssetsDiff added in v0.14.0

type TransactionSimulationAccountSummaryAssetsDiff struct {
	// This field can have the runtime type of
	// [TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAsset],
	// [TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAsset],
	// [TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAsset],
	// [NativeAssetDetails].
	Asset interface{} `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryAssetsDiffsAssetType `json:"asset_type,required"`
	// This field can have the runtime type of [[]Erc20Diff], [[]Erc721Diff],
	// [[]Erc1155Diff], [[]NativeDiff].
	In interface{} `json:"in,required"`
	// This field can have the runtime type of [[]Erc20Diff], [[]Erc721Diff],
	// [[]Erc1155Diff], [[]NativeDiff].
	Out interface{} `json:"out,required"`
	// This field can have the runtime type of
	// [TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffBalanceChanges],
	// [TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffBalanceChanges],
	// [TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffBalanceChanges],
	// [TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffBalanceChanges].
	BalanceChanges interface{}                                       `json:"balance_changes"`
	JSON           transactionSimulationAccountSummaryAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*TransactionSimulationAccountSummaryAssetsDiff) UnmarshalJSON added in v0.14.0

func (r *TransactionSimulationAccountSummaryAssetsDiff) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAccountSummaryAssetsDiffsAssetType added in v0.14.0

type TransactionSimulationAccountSummaryAssetsDiffsAssetType string

type of the asset for the current diff

const (
	TransactionSimulationAccountSummaryAssetsDiffsAssetTypeErc20   TransactionSimulationAccountSummaryAssetsDiffsAssetType = "ERC20"
	TransactionSimulationAccountSummaryAssetsDiffsAssetTypeErc721  TransactionSimulationAccountSummaryAssetsDiffsAssetType = "ERC721"
	TransactionSimulationAccountSummaryAssetsDiffsAssetTypeErc1155 TransactionSimulationAccountSummaryAssetsDiffsAssetType = "ERC1155"
	TransactionSimulationAccountSummaryAssetsDiffsAssetTypeNative  TransactionSimulationAccountSummaryAssetsDiffsAssetType = "NATIVE"
)

func (TransactionSimulationAccountSummaryAssetsDiffsAssetType) IsKnown added in v0.14.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiff added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiff struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []Erc1155Diff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out []Erc1155Diff `json:"out,required"`
	// shows the balance before making the transaction and after
	BalanceChanges TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffBalanceChanges `json:"balance_changes"`
	JSON           transactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffJSON           `json:"-"`
}

func (*TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiff) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAsset added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                                                      `json:"symbol"`
	JSON   transactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetType added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetTypeErc1155 TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetType = "ERC1155"
	TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetTypeNonerc  TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc1155TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffBalanceChanges added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffBalanceChanges struct {
	// balance of the account after making the transaction
	After Erc1155Diff `json:"after,required"`
	// balance of the account before making the transaction
	Before Erc1155Diff                                                                                          `json:"before,required"`
	JSON   transactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffBalanceChangesJSON `json:"-"`
}

shows the balance before making the transaction and after

func (*TransactionSimulationAccountSummaryAssetsDiffsErc1155AddressAssetBalanceChangeDiffBalanceChanges) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiff added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiff struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []Erc20Diff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out []Erc20Diff `json:"out,required"`
	// shows the balance before making the transaction and after
	BalanceChanges TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffBalanceChanges `json:"balance_changes"`
	JSON           transactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffJSON           `json:"-"`
}

func (*TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiff) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAsset added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetType `json:"type,required"`
	// asset's decimals
	Decimals int64 `json:"decimals"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                                                    `json:"symbol"`
	JSON   transactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc20TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetType added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetTypeErc20  TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetType = "ERC20"
	TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetTypeNonerc TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc20TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffBalanceChanges added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffBalanceChanges struct {
	// balance of the account after making the transaction
	After Erc20Diff `json:"after,required"`
	// balance of the account before making the transaction
	Before Erc20Diff                                                                                          `json:"before,required"`
	JSON   transactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffBalanceChangesJSON `json:"-"`
}

shows the balance before making the transaction and after

func (*TransactionSimulationAccountSummaryAssetsDiffsErc20AddressAssetBalanceChangeDiffBalanceChanges) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiff added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiff struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []Erc721Diff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out []Erc721Diff `json:"out,required"`
	// shows the balance before making the transaction and after
	BalanceChanges TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffBalanceChanges `json:"balance_changes"`
	JSON           transactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffJSON           `json:"-"`
}

func (*TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiff) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAsset added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                                                     `json:"symbol"`
	JSON   transactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc721TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetType added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetTypeErc721 TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetType = "ERC721"
	TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetTypeNonerc TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc721TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffBalanceChanges added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffBalanceChanges struct {
	// balance of the account after making the transaction
	After Erc721Diff `json:"after,required"`
	// balance of the account before making the transaction
	Before Erc721Diff                                                                                          `json:"before,required"`
	JSON   transactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffBalanceChangesJSON `json:"-"`
}

shows the balance before making the transaction and after

func (*TransactionSimulationAccountSummaryAssetsDiffsErc721AddressAssetBalanceChangeDiffBalanceChanges) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiff added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiff struct {
	// description of the asset for the current diff
	Asset NativeAssetDetails `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []NativeDiff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out []NativeDiff `json:"out,required"`
	// shows the balance before making the transaction and after
	BalanceChanges TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffBalanceChanges `json:"balance_changes"`
	JSON           transactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffJSON           `json:"-"`
}

func (*TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiff) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffAssetType added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffAssetType string

type of the asset for the current diff

const (
	TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffAssetTypeNative TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffAssetType = "NATIVE"
)

func (TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffBalanceChanges added in v0.29.0

type TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffBalanceChanges struct {
	// balance of the account after making the transaction
	After NativeDiff `json:"after,required"`
	// balance of the account before making the transaction
	Before NativeDiff                                                                                          `json:"before,required"`
	JSON   transactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffBalanceChangesJSON `json:"-"`
}

shows the balance before making the transaction and after

func (*TransactionSimulationAccountSummaryAssetsDiffsNativeAddressAssetBalanceChangeDiffBalanceChanges) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryExposure added in v0.29.0

type TransactionSimulationAccountSummaryExposure struct {
	// This field can have the runtime type of
	// [TransactionSimulationAccountSummaryExposuresErc20AddressExposureAsset],
	// [TransactionSimulationAccountSummaryExposuresErc721AddressExposureAsset],
	// [TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAsset].
	Asset interface{} `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryExposuresAssetType `json:"asset_type,required"`
	// This field can have the runtime type of [map[string]Erc20Exposure],
	// [map[string]Erc721Exposure], [map[string]Erc1155Exposure].
	Spenders interface{}                                     `json:"spenders,required"`
	JSON     transactionSimulationAccountSummaryExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (TransactionSimulationAccountSummaryExposure) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryExposuresUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionSimulationAccountSummaryExposuresErc20AddressExposure, TransactionSimulationAccountSummaryExposuresErc721AddressExposure, TransactionSimulationAccountSummaryExposuresErc1155AddressExposure.

func (*TransactionSimulationAccountSummaryExposure) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationAccountSummaryExposure) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAccountSummaryExposuresAssetType added in v0.29.0

type TransactionSimulationAccountSummaryExposuresAssetType string

type of the asset for the current diff

const (
	TransactionSimulationAccountSummaryExposuresAssetTypeErc20   TransactionSimulationAccountSummaryExposuresAssetType = "ERC20"
	TransactionSimulationAccountSummaryExposuresAssetTypeErc721  TransactionSimulationAccountSummaryExposuresAssetType = "ERC721"
	TransactionSimulationAccountSummaryExposuresAssetTypeErc1155 TransactionSimulationAccountSummaryExposuresAssetType = "ERC1155"
)

func (TransactionSimulationAccountSummaryExposuresAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposure added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposure struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetType `json:"asset_type,required"`
	// dictionary of spender addresses where the exposure has changed during this
	// transaction for the current address and asset
	Spenders map[string]Erc1155Exposure                                             `json:"spenders,required"`
	JSON     transactionSimulationAccountSummaryExposuresErc1155AddressExposureJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryExposuresErc1155AddressExposure) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAsset added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                                      `json:"symbol"`
	JSON   transactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetType added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetTypeErc1155 TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetType = "ERC1155"
	TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetTypeNonerc  TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc1155AddressExposureAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc1155TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryExposuresErc20AddressExposure added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc20AddressExposure struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAccountSummaryExposuresErc20AddressExposureAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetType `json:"asset_type,required"`
	// dictionary of spender addresses where the exposure has changed during this
	// transaction for the current address and asset
	Spenders map[string]Erc20Exposure                                             `json:"spenders,required"`
	JSON     transactionSimulationAccountSummaryExposuresErc20AddressExposureJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryExposuresErc20AddressExposure) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc20AddressExposureAsset added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc20AddressExposureAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetType `json:"type,required"`
	// asset's decimals
	Decimals int64 `json:"decimals"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                                    `json:"symbol"`
	JSON   transactionSimulationAccountSummaryExposuresErc20AddressExposureAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAccountSummaryExposuresErc20AddressExposureAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc20TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryExposuresErc20AddressExposureAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetType added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetTypeErc20  TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetType = "ERC20"
	TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetTypeNonerc TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc20AddressExposureAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc20TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryExposuresErc721AddressExposure added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc721AddressExposure struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAccountSummaryExposuresErc721AddressExposureAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetType `json:"asset_type,required"`
	// dictionary of spender addresses where the exposure has changed during this
	// transaction for the current address and asset
	Spenders map[string]Erc721Exposure                                             `json:"spenders,required"`
	JSON     transactionSimulationAccountSummaryExposuresErc721AddressExposureJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryExposuresErc721AddressExposure) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc721AddressExposureAsset added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc721AddressExposureAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                                     `json:"symbol"`
	JSON   transactionSimulationAccountSummaryExposuresErc721AddressExposureAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAccountSummaryExposuresErc721AddressExposureAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc721TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryExposuresErc721AddressExposureAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetType added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetTypeErc721 TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetType = "ERC721"
	TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetTypeNonerc TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryExposuresErc721AddressExposureAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc721TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryExposuresUnion added in v0.29.0

type TransactionSimulationAccountSummaryExposuresUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by TransactionSimulationAccountSummaryExposuresErc20AddressExposure, TransactionSimulationAccountSummaryExposuresErc721AddressExposure or TransactionSimulationAccountSummaryExposuresErc1155AddressExposure.

type TransactionSimulationAccountSummaryTrace added in v0.29.0

type TransactionSimulationAccountSummaryTrace struct {
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesType `json:"type,required"`
	// This field can have the runtime type of
	// [TransactionSimulationAccountSummaryTracesErc20AssetTraceAsset],
	// [TransactionSimulationAccountSummaryTracesErc721AssetTraceAsset],
	// [TransactionSimulationAccountSummaryTracesErc1155AssetTraceAsset],
	// [NativeAssetDetails].
	Asset interface{} `json:"asset"`
	// This field can have the runtime type of [Erc20Diff], [Erc721Diff],
	// [Erc1155Diff], [NativeDiff].
	Diff interface{} `json:"diff"`
	// This field can have the runtime type of
	// [TransactionSimulationAccountSummaryTracesErc20ExposureTraceExposed],
	// [TransactionSimulationAccountSummaryTracesErc721ExposureTraceExposed].
	Exposed interface{} `json:"exposed"`
	// The address where the assets are moved from
	FromAddress string `json:"from_address"`
	// This field can have the runtime type of
	// [[]TransactionSimulationAccountSummaryTracesErc20AssetTraceLabels],
	// [[]TransactionSimulationAccountSummaryTracesErc721AssetTraceLabels],
	// [[]TransactionSimulationAccountSummaryTracesErc1155AssetTraceLabels],
	// [[]TransactionSimulationAccountSummaryTracesNativeAssetTraceLabels].
	Labels interface{} `json:"labels"`
	// The owner of the assets
	Owner string `json:"owner"`
	// The spender of the assets
	Spender string `json:"spender"`
	// The address where the assets are moved to
	ToAddress string                                       `json:"to_address"`
	JSON      transactionSimulationAccountSummaryTraceJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*TransactionSimulationAccountSummaryTrace) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationAccountSummaryTrace) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAccountSummaryTracesErc1155AssetTrace added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTrace struct {
	// Description of the asset in the trace
	Asset TransactionSimulationAccountSummaryTracesErc1155AssetTraceAsset `json:"asset,required"`
	// The difference in value for the asset in the trace
	Diff Erc1155Diff `json:"diff,required"`
	// The address where the assets are moved from
	FromAddress string `json:"from_address,required"`
	// The address where the assets are moved to
	ToAddress string `json:"to_address,required"`
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesErc1155AssetTraceTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesErc1155AssetTraceType `json:"type,required"`
	// List of labels that describe the trace
	Labels []TransactionSimulationAccountSummaryTracesErc1155AssetTraceLabels `json:"labels"`
	JSON   transactionSimulationAccountSummaryTracesErc1155AssetTraceJSON     `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc1155AssetTrace) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceAsset added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                              `json:"symbol"`
	JSON   transactionSimulationAccountSummaryTracesErc1155AssetTraceAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

Description of the asset in the trace

func (TransactionSimulationAccountSummaryTracesErc1155AssetTraceAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryTracesErc1155AssetTraceAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetTypeErc1155 TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetType = "ERC1155"
	TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetTypeNonerc  TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceAssetUnion interface {
	// contains filtered or unexported methods
}

Description of the asset in the trace

Union satisfied by Erc1155TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceLabels added in v0.31.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceLabels string

An enumeration.

const (
	TransactionSimulationAccountSummaryTracesErc1155AssetTraceLabelsGasFee TransactionSimulationAccountSummaryTracesErc1155AssetTraceLabels = "GAS_FEE"
)

func (TransactionSimulationAccountSummaryTracesErc1155AssetTraceLabels) IsKnown added in v0.31.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesErc1155AssetTraceTraceTypeAssetTrace TransactionSimulationAccountSummaryTracesErc1155AssetTraceTraceType = "AssetTrace"
)

func (TransactionSimulationAccountSummaryTracesErc1155AssetTraceTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155AssetTraceType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesErc1155AssetTraceTypeErc1155AssetTrace TransactionSimulationAccountSummaryTracesErc1155AssetTraceType = "ERC1155AssetTrace"
)

func (TransactionSimulationAccountSummaryTracesErc1155AssetTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155ExposureTrace added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155ExposureTrace struct {
	// The owner of the assets
	Owner string `json:"owner,required"`
	// The spender of the assets
	Spender string `json:"spender,required"`
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesErc1155ExposureTraceTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesErc1155ExposureTraceType `json:"type,required"`
	JSON transactionSimulationAccountSummaryTracesErc1155ExposureTraceJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc1155ExposureTrace) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155ExposureTraceTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155ExposureTraceTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesErc1155ExposureTraceTraceTypeExposureTrace TransactionSimulationAccountSummaryTracesErc1155ExposureTraceTraceType = "ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesErc1155ExposureTraceTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155ExposureTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc1155ExposureTraceType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesErc1155ExposureTraceTypeErc1155ExposureTrace TransactionSimulationAccountSummaryTracesErc1155ExposureTraceType = "ERC1155ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesErc1155ExposureTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTrace added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTrace struct {
	// Description of the asset in the trace
	Asset TransactionSimulationAccountSummaryTracesErc20AssetTraceAsset `json:"asset,required"`
	// The difference in value for the asset in the trace
	Diff Erc20Diff `json:"diff,required"`
	// The address where the assets are moved from
	FromAddress string `json:"from_address,required"`
	// The address where the assets are moved to
	ToAddress string `json:"to_address,required"`
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesErc20AssetTraceTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesErc20AssetTraceType `json:"type,required"`
	// List of labels that describe the trace
	Labels []TransactionSimulationAccountSummaryTracesErc20AssetTraceLabels `json:"labels"`
	JSON   transactionSimulationAccountSummaryTracesErc20AssetTraceJSON     `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc20AssetTrace) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceAsset added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetType `json:"type,required"`
	// asset's decimals
	Decimals int64 `json:"decimals"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                            `json:"symbol"`
	JSON   transactionSimulationAccountSummaryTracesErc20AssetTraceAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

Description of the asset in the trace

func (TransactionSimulationAccountSummaryTracesErc20AssetTraceAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc20TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryTracesErc20AssetTraceAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetTypeErc20  TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetType = "ERC20"
	TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetTypeNonerc TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceAssetUnion interface {
	// contains filtered or unexported methods
}

Description of the asset in the trace

Union satisfied by Erc20TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryTracesErc20AssetTraceLabels added in v0.31.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceLabels string

An enumeration.

const (
	TransactionSimulationAccountSummaryTracesErc20AssetTraceLabelsGasFee TransactionSimulationAccountSummaryTracesErc20AssetTraceLabels = "GAS_FEE"
)

func (TransactionSimulationAccountSummaryTracesErc20AssetTraceLabels) IsKnown added in v0.31.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesErc20AssetTraceTraceTypeAssetTrace TransactionSimulationAccountSummaryTracesErc20AssetTraceTraceType = "AssetTrace"
)

func (TransactionSimulationAccountSummaryTracesErc20AssetTraceTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20AssetTraceType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesErc20AssetTraceTypeErc20AssetTrace TransactionSimulationAccountSummaryTracesErc20AssetTraceType = "ERC20AssetTrace"
)

func (TransactionSimulationAccountSummaryTracesErc20AssetTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTrace added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTrace struct {
	Exposed TransactionSimulationAccountSummaryTracesErc20ExposureTraceExposed `json:"exposed,required"`
	// The owner of the assets
	Owner string `json:"owner,required"`
	// The spender of the assets
	Spender string `json:"spender,required"`
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesErc20ExposureTraceTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesErc20ExposureTraceType `json:"type,required"`
	JSON transactionSimulationAccountSummaryTracesErc20ExposureTraceJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc20ExposureTrace) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTraceExposed added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTraceExposed struct {
	RawValue string                                                                 `json:"raw_value,required"`
	UsdPrice float64                                                                `json:"usd_price"`
	Value    float64                                                                `json:"value"`
	JSON     transactionSimulationAccountSummaryTracesErc20ExposureTraceExposedJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc20ExposureTraceExposed) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTraceTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTraceTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesErc20ExposureTraceTraceTypeExposureTrace TransactionSimulationAccountSummaryTracesErc20ExposureTraceTraceType = "ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesErc20ExposureTraceTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc20ExposureTraceType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesErc20ExposureTraceTypeErc20ExposureTrace TransactionSimulationAccountSummaryTracesErc20ExposureTraceType = "ERC20ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesErc20ExposureTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTrace added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTrace struct {
	// Description of the asset in the trace
	Asset TransactionSimulationAccountSummaryTracesErc721AssetTraceAsset `json:"asset,required"`
	// The difference in value for the asset in the trace
	Diff Erc721Diff `json:"diff,required"`
	// The address where the assets are moved from
	FromAddress string `json:"from_address,required"`
	// The address where the assets are moved to
	ToAddress string `json:"to_address,required"`
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesErc721AssetTraceTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesErc721AssetTraceType `json:"type,required"`
	// List of labels that describe the trace
	Labels []TransactionSimulationAccountSummaryTracesErc721AssetTraceLabels `json:"labels"`
	JSON   transactionSimulationAccountSummaryTracesErc721AssetTraceJSON     `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc721AssetTrace) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceAsset added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                             `json:"symbol"`
	JSON   transactionSimulationAccountSummaryTracesErc721AssetTraceAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

Description of the asset in the trace

func (TransactionSimulationAccountSummaryTracesErc721AssetTraceAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc721TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAccountSummaryTracesErc721AssetTraceAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetType string

asset type.

const (
	TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetTypeErc721 TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetType = "ERC721"
	TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetTypeNonerc TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetType = "NONERC"
)

func (TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetUnion added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceAssetUnion interface {
	// contains filtered or unexported methods
}

Description of the asset in the trace

Union satisfied by Erc721TokenDetails or NonercTokenDetails.

type TransactionSimulationAccountSummaryTracesErc721AssetTraceLabels added in v0.31.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceLabels string

An enumeration.

const (
	TransactionSimulationAccountSummaryTracesErc721AssetTraceLabelsGasFee TransactionSimulationAccountSummaryTracesErc721AssetTraceLabels = "GAS_FEE"
)

func (TransactionSimulationAccountSummaryTracesErc721AssetTraceLabels) IsKnown added in v0.31.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesErc721AssetTraceTraceTypeAssetTrace TransactionSimulationAccountSummaryTracesErc721AssetTraceTraceType = "AssetTrace"
)

func (TransactionSimulationAccountSummaryTracesErc721AssetTraceTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721AssetTraceType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesErc721AssetTraceTypeErc721AssetTrace TransactionSimulationAccountSummaryTracesErc721AssetTraceType = "ERC721AssetTrace"
)

func (TransactionSimulationAccountSummaryTracesErc721AssetTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTrace added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTrace struct {
	Exposed TransactionSimulationAccountSummaryTracesErc721ExposureTraceExposed `json:"exposed,required"`
	// The owner of the assets
	Owner string `json:"owner,required"`
	// The spender of the assets
	Spender string `json:"spender,required"`
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesErc721ExposureTraceTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesErc721ExposureTraceType `json:"type,required"`
	JSON transactionSimulationAccountSummaryTracesErc721ExposureTraceJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc721ExposureTrace) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTraceExposed added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTraceExposed struct {
	Amount   int64                                                                   `json:"amount,required"`
	TokenID  string                                                                  `json:"token_id,required"`
	IsMint   bool                                                                    `json:"is_mint"`
	LogoURL  string                                                                  `json:"logo_url"`
	UsdPrice float64                                                                 `json:"usd_price"`
	JSON     transactionSimulationAccountSummaryTracesErc721ExposureTraceExposedJSON `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesErc721ExposureTraceExposed) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTraceTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTraceTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesErc721ExposureTraceTraceTypeExposureTrace TransactionSimulationAccountSummaryTracesErc721ExposureTraceTraceType = "ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesErc721ExposureTraceTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesErc721ExposureTraceType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesErc721ExposureTraceTypeErc721ExposureTrace TransactionSimulationAccountSummaryTracesErc721ExposureTraceType = "ERC721ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesErc721ExposureTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesNativeAssetTrace added in v0.29.0

type TransactionSimulationAccountSummaryTracesNativeAssetTrace struct {
	// Description of the asset in the trace
	Asset NativeAssetDetails `json:"asset,required"`
	// The difference in value for the asset in the trace
	Diff NativeDiff `json:"diff,required"`
	// The address where the assets are moved from
	FromAddress string `json:"from_address,required"`
	// The address where the assets are moved to
	ToAddress string `json:"to_address,required"`
	// type of the trace
	TraceType TransactionSimulationAccountSummaryTracesNativeAssetTraceTraceType `json:"trace_type,required"`
	// The type of the model
	Type TransactionSimulationAccountSummaryTracesNativeAssetTraceType `json:"type,required"`
	// List of labels that describe the trace
	Labels []TransactionSimulationAccountSummaryTracesNativeAssetTraceLabels `json:"labels"`
	JSON   transactionSimulationAccountSummaryTracesNativeAssetTraceJSON     `json:"-"`
}

func (*TransactionSimulationAccountSummaryTracesNativeAssetTrace) UnmarshalJSON added in v0.29.0

type TransactionSimulationAccountSummaryTracesNativeAssetTraceLabels added in v0.31.0

type TransactionSimulationAccountSummaryTracesNativeAssetTraceLabels string

An enumeration.

const (
	TransactionSimulationAccountSummaryTracesNativeAssetTraceLabelsGasFee TransactionSimulationAccountSummaryTracesNativeAssetTraceLabels = "GAS_FEE"
)

func (TransactionSimulationAccountSummaryTracesNativeAssetTraceLabels) IsKnown added in v0.31.0

type TransactionSimulationAccountSummaryTracesNativeAssetTraceTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesNativeAssetTraceTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesNativeAssetTraceTraceTypeAssetTrace TransactionSimulationAccountSummaryTracesNativeAssetTraceTraceType = "AssetTrace"
)

func (TransactionSimulationAccountSummaryTracesNativeAssetTraceTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesNativeAssetTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesNativeAssetTraceType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesNativeAssetTraceTypeNativeAssetTrace TransactionSimulationAccountSummaryTracesNativeAssetTraceType = "NativeAssetTrace"
)

func (TransactionSimulationAccountSummaryTracesNativeAssetTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesTraceType added in v0.29.0

type TransactionSimulationAccountSummaryTracesTraceType string

type of the trace

const (
	TransactionSimulationAccountSummaryTracesTraceTypeAssetTrace    TransactionSimulationAccountSummaryTracesTraceType = "AssetTrace"
	TransactionSimulationAccountSummaryTracesTraceTypeExposureTrace TransactionSimulationAccountSummaryTracesTraceType = "ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesTraceType) IsKnown added in v0.29.0

type TransactionSimulationAccountSummaryTracesType added in v0.29.0

type TransactionSimulationAccountSummaryTracesType string

The type of the model

const (
	TransactionSimulationAccountSummaryTracesTypeErc20AssetTrace      TransactionSimulationAccountSummaryTracesType = "ERC20AssetTrace"
	TransactionSimulationAccountSummaryTracesTypeErc721AssetTrace     TransactionSimulationAccountSummaryTracesType = "ERC721AssetTrace"
	TransactionSimulationAccountSummaryTracesTypeErc1155AssetTrace    TransactionSimulationAccountSummaryTracesType = "ERC1155AssetTrace"
	TransactionSimulationAccountSummaryTracesTypeNativeAssetTrace     TransactionSimulationAccountSummaryTracesType = "NativeAssetTrace"
	TransactionSimulationAccountSummaryTracesTypeErc20ExposureTrace   TransactionSimulationAccountSummaryTracesType = "ERC20ExposureTrace"
	TransactionSimulationAccountSummaryTracesTypeErc721ExposureTrace  TransactionSimulationAccountSummaryTracesType = "ERC721ExposureTrace"
	TransactionSimulationAccountSummaryTracesTypeErc1155ExposureTrace TransactionSimulationAccountSummaryTracesType = "ERC1155ExposureTrace"
)

func (TransactionSimulationAccountSummaryTracesType) IsKnown added in v0.29.0

type TransactionSimulationAddressDetail

type TransactionSimulationAddressDetail struct {
	// contains the contract's name if the address is a verified contract
	ContractName string `json:"contract_name"`
	// Whether the address is an eoa or a contract
	IsEoa bool `json:"is_eoa"`
	// known name tag for the address
	NameTag string                                 `json:"name_tag"`
	JSON    transactionSimulationAddressDetailJSON `json:"-"`
}

func (*TransactionSimulationAddressDetail) UnmarshalJSON

func (r *TransactionSimulationAddressDetail) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAssetsDiff added in v0.29.0

type TransactionSimulationAssetsDiff struct {
	// This field can have the runtime type of
	// [TransactionSimulationAssetsDiffsErc20AddressAssetDiffAsset],
	// [TransactionSimulationAssetsDiffsErc721AddressAssetDiffAsset],
	// [TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAsset],
	// [NativeAssetDetails].
	Asset interface{} `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAssetsDiffsAssetType `json:"asset_type,required"`
	// This field can have the runtime type of [[]Erc20Diff], [[]Erc721Diff],
	// [[]Erc1155Diff], [[]NativeDiff].
	In interface{} `json:"in,required"`
	// This field can have the runtime type of [[]Erc20Diff], [[]Erc721Diff],
	// [[]Erc1155Diff], [[]NativeDiff].
	Out  interface{}                         `json:"out,required"`
	JSON transactionSimulationAssetsDiffJSON `json:"-"`
	// contains filtered or unexported fields
}

func (TransactionSimulationAssetsDiff) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAssetsDiffsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionSimulationAssetsDiffsErc20AddressAssetDiff, TransactionSimulationAssetsDiffsErc721AddressAssetDiff, TransactionSimulationAssetsDiffsErc1155AddressAssetDiff, TransactionSimulationAssetsDiffsNativeAddressAssetDiff.

func (*TransactionSimulationAssetsDiff) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationAssetsDiff) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAssetsDiffsAssetType added in v0.29.0

type TransactionSimulationAssetsDiffsAssetType string

type of the asset for the current diff

const (
	TransactionSimulationAssetsDiffsAssetTypeErc20   TransactionSimulationAssetsDiffsAssetType = "ERC20"
	TransactionSimulationAssetsDiffsAssetTypeErc721  TransactionSimulationAssetsDiffsAssetType = "ERC721"
	TransactionSimulationAssetsDiffsAssetTypeErc1155 TransactionSimulationAssetsDiffsAssetType = "ERC1155"
	TransactionSimulationAssetsDiffsAssetTypeNative  TransactionSimulationAssetsDiffsAssetType = "NATIVE"
)

func (TransactionSimulationAssetsDiffsAssetType) IsKnown added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiff added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiff struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []Erc1155Diff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out  []Erc1155Diff                                               `json:"out,required"`
	JSON transactionSimulationAssetsDiffsErc1155AddressAssetDiffJSON `json:"-"`
}

func (*TransactionSimulationAssetsDiffsErc1155AddressAssetDiff) UnmarshalJSON added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAsset added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                           `json:"symbol"`
	JSON   transactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetType added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetType string

asset type.

const (
	TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetTypeErc1155 TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetType = "ERC1155"
	TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetTypeNonerc  TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetType = "NONERC"
)

func (TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetUnion added in v0.29.0

type TransactionSimulationAssetsDiffsErc1155AddressAssetDiffAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc1155TokenDetails or NonercTokenDetails.

type TransactionSimulationAssetsDiffsErc20AddressAssetDiff added in v0.29.0

type TransactionSimulationAssetsDiffsErc20AddressAssetDiff struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAssetsDiffsErc20AddressAssetDiffAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []Erc20Diff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out  []Erc20Diff                                               `json:"out,required"`
	JSON transactionSimulationAssetsDiffsErc20AddressAssetDiffJSON `json:"-"`
}

func (*TransactionSimulationAssetsDiffsErc20AddressAssetDiff) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationAssetsDiffsErc20AddressAssetDiff) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAssetsDiffsErc20AddressAssetDiffAsset added in v0.29.0

type TransactionSimulationAssetsDiffsErc20AddressAssetDiffAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetType `json:"type,required"`
	// asset's decimals
	Decimals int64 `json:"decimals"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                         `json:"symbol"`
	JSON   transactionSimulationAssetsDiffsErc20AddressAssetDiffAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAssetsDiffsErc20AddressAssetDiffAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc20TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAssetsDiffsErc20AddressAssetDiffAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetType added in v0.29.0

type TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetType string

asset type.

const (
	TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetTypeErc20  TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetType = "ERC20"
	TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetTypeNonerc TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetType = "NONERC"
)

func (TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetUnion added in v0.29.0

type TransactionSimulationAssetsDiffsErc20AddressAssetDiffAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc20TokenDetails or NonercTokenDetails.

type TransactionSimulationAssetsDiffsErc721AddressAssetDiff added in v0.29.0

type TransactionSimulationAssetsDiffsErc721AddressAssetDiff struct {
	// description of the asset for the current diff
	Asset TransactionSimulationAssetsDiffsErc721AddressAssetDiffAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []Erc721Diff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out  []Erc721Diff                                               `json:"out,required"`
	JSON transactionSimulationAssetsDiffsErc721AddressAssetDiffJSON `json:"-"`
}

func (*TransactionSimulationAssetsDiffsErc721AddressAssetDiff) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationAssetsDiffsErc721AddressAssetDiff) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAssetsDiffsErc721AddressAssetDiffAsset added in v0.29.0

type TransactionSimulationAssetsDiffsErc721AddressAssetDiffAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                          `json:"symbol"`
	JSON   transactionSimulationAssetsDiffsErc721AddressAssetDiffAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationAssetsDiffsErc721AddressAssetDiffAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc721TokenDetails, NonercTokenDetails.

func (*TransactionSimulationAssetsDiffsErc721AddressAssetDiffAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetType added in v0.29.0

type TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetType string

asset type.

const (
	TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetTypeErc721 TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetType = "ERC721"
	TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetTypeNonerc TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetType = "NONERC"
)

func (TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetUnion added in v0.29.0

type TransactionSimulationAssetsDiffsErc721AddressAssetDiffAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc721TokenDetails or NonercTokenDetails.

type TransactionSimulationAssetsDiffsNativeAddressAssetDiff added in v0.29.0

type TransactionSimulationAssetsDiffsNativeAddressAssetDiff struct {
	// description of the asset for the current diff
	Asset NativeAssetDetails `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationAssetsDiffsNativeAddressAssetDiffAssetType `json:"asset_type,required"`
	// amount of the asset that was transferred to the address in this transaction
	In []NativeDiff `json:"in,required"`
	// amount of the asset that was transferred from the address in this transaction
	Out  []NativeDiff                                               `json:"out,required"`
	JSON transactionSimulationAssetsDiffsNativeAddressAssetDiffJSON `json:"-"`
}

func (*TransactionSimulationAssetsDiffsNativeAddressAssetDiff) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationAssetsDiffsNativeAddressAssetDiff) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationAssetsDiffsNativeAddressAssetDiffAssetType added in v0.29.0

type TransactionSimulationAssetsDiffsNativeAddressAssetDiffAssetType string

type of the asset for the current diff

const (
	TransactionSimulationAssetsDiffsNativeAddressAssetDiffAssetTypeNative TransactionSimulationAssetsDiffsNativeAddressAssetDiffAssetType = "NATIVE"
)

func (TransactionSimulationAssetsDiffsNativeAddressAssetDiffAssetType) IsKnown added in v0.29.0

type TransactionSimulationContractManagement added in v0.22.1

type TransactionSimulationContractManagement struct {
	// This field can have the runtime type of
	// [TransactionSimulationContractManagementProxyUpgradeManagementAfter],
	// [TransactionSimulationContractManagementOwnershipChangeManagementAfter],
	// [TransactionSimulationContractManagementModulesChangeManagementAfter].
	After interface{} `json:"after,required"`
	// This field can have the runtime type of
	// [TransactionSimulationContractManagementProxyUpgradeManagementBefore],
	// [TransactionSimulationContractManagementOwnershipChangeManagementBefore],
	// [TransactionSimulationContractManagementModulesChangeManagementBefore].
	Before interface{} `json:"before,required"`
	// The type of the state change
	Type TransactionSimulationContractManagementType `json:"type,required"`
	JSON transactionSimulationContractManagementJSON `json:"-"`
	// contains filtered or unexported fields
}

func (TransactionSimulationContractManagement) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationContractManagementUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionSimulationContractManagementProxyUpgradeManagement, TransactionSimulationContractManagementOwnershipChangeManagement, TransactionSimulationContractManagementModulesChangeManagement.

func (*TransactionSimulationContractManagement) UnmarshalJSON added in v0.22.1

func (r *TransactionSimulationContractManagement) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationContractManagementModulesChangeManagement added in v0.29.0

type TransactionSimulationContractManagementModulesChangeManagement struct {
	// The state after the transaction
	After TransactionSimulationContractManagementModulesChangeManagementAfter `json:"after,required"`
	// The state before the transaction
	Before TransactionSimulationContractManagementModulesChangeManagementBefore `json:"before,required"`
	// The type of the state change
	Type TransactionSimulationContractManagementModulesChangeManagementType `json:"type,required"`
	JSON transactionSimulationContractManagementModulesChangeManagementJSON `json:"-"`
}

func (*TransactionSimulationContractManagementModulesChangeManagement) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementModulesChangeManagementAfter added in v0.29.0

type TransactionSimulationContractManagementModulesChangeManagementAfter struct {
	Modules []string                                                                `json:"modules,required"`
	JSON    transactionSimulationContractManagementModulesChangeManagementAfterJSON `json:"-"`
}

The state after the transaction

func (*TransactionSimulationContractManagementModulesChangeManagementAfter) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementModulesChangeManagementBefore added in v0.29.0

type TransactionSimulationContractManagementModulesChangeManagementBefore struct {
	Modules []string                                                                 `json:"modules,required"`
	JSON    transactionSimulationContractManagementModulesChangeManagementBeforeJSON `json:"-"`
}

The state before the transaction

func (*TransactionSimulationContractManagementModulesChangeManagementBefore) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementModulesChangeManagementType added in v0.29.0

type TransactionSimulationContractManagementModulesChangeManagementType string

The type of the state change

const (
	TransactionSimulationContractManagementModulesChangeManagementTypeModuleChange TransactionSimulationContractManagementModulesChangeManagementType = "MODULE_CHANGE"
)

func (TransactionSimulationContractManagementModulesChangeManagementType) IsKnown added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagement added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagement struct {
	// The state after the transaction
	After TransactionSimulationContractManagementOwnershipChangeManagementAfter `json:"after,required"`
	// The state before the transaction
	Before TransactionSimulationContractManagementOwnershipChangeManagementBefore `json:"before,required"`
	// The type of the state change
	Type TransactionSimulationContractManagementOwnershipChangeManagementType `json:"type,required"`
	JSON transactionSimulationContractManagementOwnershipChangeManagementJSON `json:"-"`
}

func (*TransactionSimulationContractManagementOwnershipChangeManagement) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagementAfter added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagementAfter struct {
	Owners []string                                                                  `json:"owners,required"`
	JSON   transactionSimulationContractManagementOwnershipChangeManagementAfterJSON `json:"-"`
}

The state after the transaction

func (*TransactionSimulationContractManagementOwnershipChangeManagementAfter) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagementBefore added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagementBefore struct {
	Owners []string                                                                   `json:"owners,required"`
	JSON   transactionSimulationContractManagementOwnershipChangeManagementBeforeJSON `json:"-"`
}

The state before the transaction

func (*TransactionSimulationContractManagementOwnershipChangeManagementBefore) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagementType added in v0.29.0

type TransactionSimulationContractManagementOwnershipChangeManagementType string

The type of the state change

const (
	TransactionSimulationContractManagementOwnershipChangeManagementTypeOwnershipChange TransactionSimulationContractManagementOwnershipChangeManagementType = "OWNERSHIP_CHANGE"
)

func (TransactionSimulationContractManagementOwnershipChangeManagementType) IsKnown added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagement added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagement struct {
	// The state after the transaction
	After TransactionSimulationContractManagementProxyUpgradeManagementAfter `json:"after,required"`
	// The state before the transaction
	Before TransactionSimulationContractManagementProxyUpgradeManagementBefore `json:"before,required"`
	// The type of the state change
	Type TransactionSimulationContractManagementProxyUpgradeManagementType `json:"type,required"`
	JSON transactionSimulationContractManagementProxyUpgradeManagementJSON `json:"-"`
}

func (*TransactionSimulationContractManagementProxyUpgradeManagement) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagementAfter added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagementAfter struct {
	Address string                                                                 `json:"address,required"`
	JSON    transactionSimulationContractManagementProxyUpgradeManagementAfterJSON `json:"-"`
}

The state after the transaction

func (*TransactionSimulationContractManagementProxyUpgradeManagementAfter) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagementBefore added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagementBefore struct {
	Address string                                                                  `json:"address,required"`
	JSON    transactionSimulationContractManagementProxyUpgradeManagementBeforeJSON `json:"-"`
}

The state before the transaction

func (*TransactionSimulationContractManagementProxyUpgradeManagementBefore) UnmarshalJSON added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagementType added in v0.29.0

type TransactionSimulationContractManagementProxyUpgradeManagementType string

The type of the state change

const (
	TransactionSimulationContractManagementProxyUpgradeManagementTypeProxyUpgrade TransactionSimulationContractManagementProxyUpgradeManagementType = "PROXY_UPGRADE"
)

func (TransactionSimulationContractManagementProxyUpgradeManagementType) IsKnown added in v0.29.0

type TransactionSimulationContractManagementType added in v0.22.1

type TransactionSimulationContractManagementType string

The type of the state change

const (
	TransactionSimulationContractManagementTypeProxyUpgrade    TransactionSimulationContractManagementType = "PROXY_UPGRADE"
	TransactionSimulationContractManagementTypeOwnershipChange TransactionSimulationContractManagementType = "OWNERSHIP_CHANGE"
	TransactionSimulationContractManagementTypeModuleChange    TransactionSimulationContractManagementType = "MODULE_CHANGE"
)

func (TransactionSimulationContractManagementType) IsKnown added in v0.22.1

type TransactionSimulationContractManagementUnion added in v0.29.0

type TransactionSimulationContractManagementUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by TransactionSimulationContractManagementProxyUpgradeManagement, TransactionSimulationContractManagementOwnershipChangeManagement or TransactionSimulationContractManagementModulesChangeManagement.

type TransactionSimulationError added in v0.7.3

type TransactionSimulationError struct {
	// An error message if the simulation failed.
	Error string `json:"error,required"`
	// A string indicating if the simulation was successful or not.
	Status TransactionSimulationErrorStatus `json:"status,required"`
	// Error details if the simulation failed.
	ErrorDetails TransactionSimulationErrorErrorDetails `json:"error_details"`
	JSON         transactionSimulationErrorJSON         `json:"-"`
}

func (*TransactionSimulationError) UnmarshalJSON added in v0.7.3

func (r *TransactionSimulationError) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationErrorErrorDetails added in v0.30.0

type TransactionSimulationErrorErrorDetails struct {
	// The type of the model
	Code string `json:"code,required"`
	// The address of the account
	AccountAddress string `json:"account_address"`
	// This field can have the runtime type of
	// [TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAsset].
	Asset interface{} `json:"asset"`
	// The current balance of the account
	CurrentBalance int64 `json:"current_balance"`
	// The required balance of the account
	RequiredBalance int64                                      `json:"required_balance"`
	JSON            transactionSimulationErrorErrorDetailsJSON `json:"-"`
	// contains filtered or unexported fields
}

Error details if the simulation failed.

func (TransactionSimulationErrorErrorDetails) AsUnion added in v0.30.0

AsUnion returns a TransactionSimulationErrorErrorDetailsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetails, TransactionSimulationErrorErrorDetailsGenericErrorDetails.

func (*TransactionSimulationErrorErrorDetails) UnmarshalJSON added in v0.30.0

func (r *TransactionSimulationErrorErrorDetails) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetails added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetails struct {
	// The address of the account
	AccountAddress string `json:"account_address,required"`
	// The asset that the account does not have enough balance for
	Asset TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAsset `json:"asset,required"`
	// The type of the model
	Code TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsCode `json:"code,required"`
	// The current balance of the account
	CurrentBalance int64 `json:"current_balance"`
	// The required balance of the account
	RequiredBalance int64                                                                          `json:"required_balance"`
	JSON            transactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsJSON `json:"-"`
}

func (*TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetails) UnmarshalJSON added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAsset added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAsset struct {
	// This field can have the runtime type of [NativeAssetDetails],
	// [Erc20TokenDetails], [Erc1155TokenDetails].
	Details interface{} `json:"details,required"`
	// The type of the model
	Type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType `json:"type,required"`
	// Token Id
	TokenID int64                                                                               `json:"token_id"`
	JSON    transactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

The asset that the account does not have enough balance for

func (*TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAsset) UnmarshalJSON added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155Asset added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155Asset struct {
	// Details
	Details Erc1155TokenDetails `json:"details,required"`
	// Token Id
	TokenID int64 `json:"token_id,required"`
	// The type of the model
	Type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155AssetType `json:"type,required"`
	JSON transactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155AssetJSON `json:"-"`
}

func (*TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155Asset) UnmarshalJSON added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155AssetType added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155AssetType string

The type of the model

const (
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155AssetTypeErc1155 TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155AssetType = "ERC1155"
)

func (TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc1155AssetType) IsKnown added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20Asset added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20Asset struct {
	// Details
	Details Erc20TokenDetails `json:"details,required"`
	// The type of the model
	Type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20AssetType `json:"type,required"`
	JSON transactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20AssetJSON `json:"-"`
}

func (*TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20Asset) UnmarshalJSON added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20AssetType added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20AssetType string

The type of the model

const (
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20AssetTypeErc20 TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20AssetType = "ERC20"
)

func (TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc20AssetType) IsKnown added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721Asset added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721Asset struct {
	// Details
	Details Erc1155TokenDetails `json:"details,required"`
	// Token Id
	TokenID int64 `json:"token_id,required"`
	// The type of the model
	Type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721AssetType `json:"type,required"`
	JSON transactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721AssetJSON `json:"-"`
}

func (*TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721Asset) UnmarshalJSON added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721AssetType added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721AssetType string

The type of the model

const (
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721AssetTypeErc721 TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721AssetType = "ERC721"
)

func (TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetErc721AssetType) IsKnown added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAsset added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAsset struct {
	// Details
	Details NativeAssetDetails `json:"details,required"`
	// The type of the model
	Type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAssetType `json:"type,required"`
	JSON transactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAssetJSON `json:"-"`
}

func (*TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAsset) UnmarshalJSON added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAssetType added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAssetType string

The type of the model

const (
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAssetTypeNative TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAssetType = "NATIVE"
)

func (TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetNativeAssetType) IsKnown added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType string

The type of the model

const (
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetTypeNative  TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType = "NATIVE"
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetTypeErc20   TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType = "ERC20"
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetTypeErc721  TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType = "ERC721"
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetTypeErc1155 TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType = "ERC1155"
)

func (TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsAssetType) IsKnown added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsCode added in v0.30.0

type TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsCode string

The type of the model

const (
	TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsCodeGeneralInsufficientFunds TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsCode = "GENERAL_INSUFFICIENT_FUNDS"
)

func (TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetailsCode) IsKnown added in v0.30.0

type TransactionSimulationErrorErrorDetailsGenericErrorDetails added in v0.30.0

type TransactionSimulationErrorErrorDetailsGenericErrorDetails struct {
	// The error code
	Code string                                                        `json:"code,required"`
	JSON transactionSimulationErrorErrorDetailsGenericErrorDetailsJSON `json:"-"`
}

func (*TransactionSimulationErrorErrorDetailsGenericErrorDetails) UnmarshalJSON added in v0.30.0

type TransactionSimulationErrorErrorDetailsUnion added in v0.30.0

type TransactionSimulationErrorErrorDetailsUnion interface {
	// contains filtered or unexported methods
}

Error details if the simulation failed.

Union satisfied by TransactionSimulationErrorErrorDetailsGeneralInsufficientFundsErrorDetails or TransactionSimulationErrorErrorDetailsGenericErrorDetails.

type TransactionSimulationErrorStatus added in v0.8.0

type TransactionSimulationErrorStatus string

A string indicating if the simulation was successful or not.

const (
	TransactionSimulationErrorStatusError TransactionSimulationErrorStatus = "Error"
)

func (TransactionSimulationErrorStatus) IsKnown added in v0.8.0

type TransactionSimulationExposure added in v0.29.0

type TransactionSimulationExposure struct {
	// This field can have the runtime type of
	// [TransactionSimulationExposuresErc20AddressExposureAsset],
	// [TransactionSimulationExposuresErc721AddressExposureAsset],
	// [TransactionSimulationExposuresErc1155AddressExposureAsset].
	Asset interface{} `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationExposuresAssetType `json:"asset_type,required"`
	// This field can have the runtime type of [map[string]Erc20Exposure],
	// [map[string]Erc721Exposure], [map[string]Erc1155Exposure].
	Spenders interface{}                       `json:"spenders,required"`
	JSON     transactionSimulationExposureJSON `json:"-"`
	// contains filtered or unexported fields
}

func (TransactionSimulationExposure) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationExposuresUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are TransactionSimulationExposuresErc20AddressExposure, TransactionSimulationExposuresErc721AddressExposure, TransactionSimulationExposuresErc1155AddressExposure.

func (*TransactionSimulationExposure) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationExposure) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationExposuresAssetType added in v0.29.0

type TransactionSimulationExposuresAssetType string

type of the asset for the current diff

const (
	TransactionSimulationExposuresAssetTypeErc20   TransactionSimulationExposuresAssetType = "ERC20"
	TransactionSimulationExposuresAssetTypeErc721  TransactionSimulationExposuresAssetType = "ERC721"
	TransactionSimulationExposuresAssetTypeErc1155 TransactionSimulationExposuresAssetType = "ERC1155"
)

func (TransactionSimulationExposuresAssetType) IsKnown added in v0.29.0

type TransactionSimulationExposuresErc1155AddressExposure added in v0.29.0

type TransactionSimulationExposuresErc1155AddressExposure struct {
	// description of the asset for the current diff
	Asset TransactionSimulationExposuresErc1155AddressExposureAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationExposuresErc1155AddressExposureAssetType `json:"asset_type,required"`
	// dictionary of spender addresses where the exposure has changed during this
	// transaction for the current address and asset
	Spenders map[string]Erc1155Exposure                               `json:"spenders,required"`
	JSON     transactionSimulationExposuresErc1155AddressExposureJSON `json:"-"`
}

func (*TransactionSimulationExposuresErc1155AddressExposure) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationExposuresErc1155AddressExposure) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationExposuresErc1155AddressExposureAsset added in v0.29.0

type TransactionSimulationExposuresErc1155AddressExposureAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationExposuresErc1155AddressExposureAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                        `json:"symbol"`
	JSON   transactionSimulationExposuresErc1155AddressExposureAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationExposuresErc1155AddressExposureAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationExposuresErc1155AddressExposureAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc1155TokenDetails, NonercTokenDetails.

func (*TransactionSimulationExposuresErc1155AddressExposureAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationExposuresErc1155AddressExposureAssetType added in v0.29.0

type TransactionSimulationExposuresErc1155AddressExposureAssetType string

asset type.

const (
	TransactionSimulationExposuresErc1155AddressExposureAssetTypeErc1155 TransactionSimulationExposuresErc1155AddressExposureAssetType = "ERC1155"
	TransactionSimulationExposuresErc1155AddressExposureAssetTypeNonerc  TransactionSimulationExposuresErc1155AddressExposureAssetType = "NONERC"
)

func (TransactionSimulationExposuresErc1155AddressExposureAssetType) IsKnown added in v0.29.0

type TransactionSimulationExposuresErc1155AddressExposureAssetUnion added in v0.29.0

type TransactionSimulationExposuresErc1155AddressExposureAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc1155TokenDetails or NonercTokenDetails.

type TransactionSimulationExposuresErc20AddressExposure added in v0.29.0

type TransactionSimulationExposuresErc20AddressExposure struct {
	// description of the asset for the current diff
	Asset TransactionSimulationExposuresErc20AddressExposureAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationExposuresErc20AddressExposureAssetType `json:"asset_type,required"`
	// dictionary of spender addresses where the exposure has changed during this
	// transaction for the current address and asset
	Spenders map[string]Erc20Exposure                               `json:"spenders,required"`
	JSON     transactionSimulationExposuresErc20AddressExposureJSON `json:"-"`
}

func (*TransactionSimulationExposuresErc20AddressExposure) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationExposuresErc20AddressExposure) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationExposuresErc20AddressExposureAsset added in v0.29.0

type TransactionSimulationExposuresErc20AddressExposureAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationExposuresErc20AddressExposureAssetType `json:"type,required"`
	// asset's decimals
	Decimals int64 `json:"decimals"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                      `json:"symbol"`
	JSON   transactionSimulationExposuresErc20AddressExposureAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationExposuresErc20AddressExposureAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationExposuresErc20AddressExposureAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc20TokenDetails, NonercTokenDetails.

func (*TransactionSimulationExposuresErc20AddressExposureAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationExposuresErc20AddressExposureAssetType added in v0.29.0

type TransactionSimulationExposuresErc20AddressExposureAssetType string

asset type.

const (
	TransactionSimulationExposuresErc20AddressExposureAssetTypeErc20  TransactionSimulationExposuresErc20AddressExposureAssetType = "ERC20"
	TransactionSimulationExposuresErc20AddressExposureAssetTypeNonerc TransactionSimulationExposuresErc20AddressExposureAssetType = "NONERC"
)

func (TransactionSimulationExposuresErc20AddressExposureAssetType) IsKnown added in v0.29.0

type TransactionSimulationExposuresErc20AddressExposureAssetUnion added in v0.29.0

type TransactionSimulationExposuresErc20AddressExposureAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc20TokenDetails or NonercTokenDetails.

type TransactionSimulationExposuresErc721AddressExposure added in v0.29.0

type TransactionSimulationExposuresErc721AddressExposure struct {
	// description of the asset for the current diff
	Asset TransactionSimulationExposuresErc721AddressExposureAsset `json:"asset,required"`
	// type of the asset for the current diff
	AssetType TransactionSimulationExposuresErc721AddressExposureAssetType `json:"asset_type,required"`
	// dictionary of spender addresses where the exposure has changed during this
	// transaction for the current address and asset
	Spenders map[string]Erc721Exposure                               `json:"spenders,required"`
	JSON     transactionSimulationExposuresErc721AddressExposureJSON `json:"-"`
}

func (*TransactionSimulationExposuresErc721AddressExposure) UnmarshalJSON added in v0.29.0

func (r *TransactionSimulationExposuresErc721AddressExposure) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationExposuresErc721AddressExposureAsset added in v0.29.0

type TransactionSimulationExposuresErc721AddressExposureAsset struct {
	// address of the token
	Address string `json:"address,required"`
	// asset type.
	Type TransactionSimulationExposuresErc721AddressExposureAssetType `json:"type,required"`
	// url of the token logo
	LogoURL string `json:"logo_url"`
	// string represents the name of the asset
	Name string `json:"name"`
	// asset's symbol name
	Symbol string                                                       `json:"symbol"`
	JSON   transactionSimulationExposuresErc721AddressExposureAssetJSON `json:"-"`
	// contains filtered or unexported fields
}

description of the asset for the current diff

func (TransactionSimulationExposuresErc721AddressExposureAsset) AsUnion added in v0.29.0

AsUnion returns a TransactionSimulationExposuresErc721AddressExposureAssetUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are Erc721TokenDetails, NonercTokenDetails.

func (*TransactionSimulationExposuresErc721AddressExposureAsset) UnmarshalJSON added in v0.29.0

type TransactionSimulationExposuresErc721AddressExposureAssetType added in v0.29.0

type TransactionSimulationExposuresErc721AddressExposureAssetType string

asset type.

const (
	TransactionSimulationExposuresErc721AddressExposureAssetTypeErc721 TransactionSimulationExposuresErc721AddressExposureAssetType = "ERC721"
	TransactionSimulationExposuresErc721AddressExposureAssetTypeNonerc TransactionSimulationExposuresErc721AddressExposureAssetType = "NONERC"
)

func (TransactionSimulationExposuresErc721AddressExposureAssetType) IsKnown added in v0.29.0

type TransactionSimulationExposuresErc721AddressExposureAssetUnion added in v0.29.0

type TransactionSimulationExposuresErc721AddressExposureAssetUnion interface {
	// contains filtered or unexported methods
}

description of the asset for the current diff

Union satisfied by Erc721TokenDetails or NonercTokenDetails.

type TransactionSimulationExposuresUnion added in v0.29.0

type TransactionSimulationExposuresUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by TransactionSimulationExposuresErc20AddressExposure, TransactionSimulationExposuresErc721AddressExposure or TransactionSimulationExposuresErc1155AddressExposure.

type TransactionSimulationParams added in v0.19.0

type TransactionSimulationParams struct {
	// The block tag to be sent.
	BlockTag string `json:"block_tag"`
	// The calldata to be sent.
	Calldata TransactionSimulationParamsCalldata `json:"calldata"`
	// The chain to be sent.
	Chain string `json:"chain"`
	// The data to be sent.
	Data string `json:"data"`
	// The address the transaction is sent from.
	From string `json:"from"`
	// The gas to be sent.
	Gas string `json:"gas"`
	// The gas price to be sent.
	GasPrice string `json:"gas_price"`
	// The address the transaction is directed to.
	To string `json:"to"`
	// The value to be sent.
	Value string                          `json:"value"`
	JSON  transactionSimulationParamsJSON `json:"-"`
}

The parameters of the transaction that was simulated.

func (*TransactionSimulationParams) UnmarshalJSON added in v0.19.0

func (r *TransactionSimulationParams) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationParamsCalldata added in v0.19.0

type TransactionSimulationParamsCalldata struct {
	// The function selector of the function called in the transaction
	FunctionSelector string `json:"function_selector,required"`
	// The function declaration of the function called in the transaction
	FunctionDeclaration string `json:"function_declaration"`
	// The function signature of the function called in the transaction
	FunctionSignature string                                  `json:"function_signature"`
	JSON              transactionSimulationParamsCalldataJSON `json:"-"`
}

The calldata to be sent.

func (*TransactionSimulationParamsCalldata) UnmarshalJSON added in v0.19.0

func (r *TransactionSimulationParamsCalldata) UnmarshalJSON(data []byte) (err error)

type TransactionSimulationStatus added in v0.8.0

type TransactionSimulationStatus string

A string indicating if the simulation was successful or not.

const (
	TransactionSimulationStatusSuccess TransactionSimulationStatus = "Success"
)

func (TransactionSimulationStatus) IsKnown added in v0.8.0

func (r TransactionSimulationStatus) IsKnown() bool

type TransactionValidation

type TransactionValidation struct {
	// A list of features about this transaction explaining the validation.
	Features []TransactionScanFeature `json:"features,required"`
	// An enumeration.
	ResultType TransactionValidationResultType `json:"result_type,required"`
	// A string indicating if the simulation was successful or not.
	Status TransactionValidationStatus `json:"status,required"`
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification string `json:"classification"`
	// A textual description that can be presented to the user about what this
	// transaction is doing.
	Description string `json:"description"`
	// A textual description about the reasons the transaction was flagged with
	// result_type.
	Reason string                    `json:"reason"`
	JSON   transactionValidationJSON `json:"-"`
}

func (*TransactionValidation) UnmarshalJSON

func (r *TransactionValidation) UnmarshalJSON(data []byte) (err error)

type TransactionValidationError added in v0.7.3

type TransactionValidationError struct {
	// A textual classification that can be presented to the user explaining the
	// reason.
	Classification TransactionValidationErrorClassification `json:"classification,required"`
	// A textual description that can be presented to the user about what this
	// transaction is doing.
	Description TransactionValidationErrorDescription `json:"description,required"`
	// An error message if the validation failed.
	Error string `json:"error,required"`
	// A list of features about this transaction explaining the validation.
	Features []TransactionScanFeature `json:"features,required"`
	// A textual description about the reasons the transaction was flagged with
	// result_type.
	Reason TransactionValidationErrorReason `json:"reason,required"`
	// A string indicating if the transaction is safe to sign or not.
	ResultType TransactionValidationErrorResultType `json:"result_type,required"`
	// A string indicating if the simulation was successful or not.
	Status TransactionValidationErrorStatus `json:"status,required"`
	JSON   transactionValidationErrorJSON   `json:"-"`
}

func (*TransactionValidationError) UnmarshalJSON added in v0.7.3

func (r *TransactionValidationError) UnmarshalJSON(data []byte) (err error)

type TransactionValidationErrorClassification added in v0.7.3

type TransactionValidationErrorClassification string

A textual classification that can be presented to the user explaining the reason.

const (
	TransactionValidationErrorClassificationEmpty TransactionValidationErrorClassification = ""
)

func (TransactionValidationErrorClassification) IsKnown added in v0.7.3

type TransactionValidationErrorDescription added in v0.7.3

type TransactionValidationErrorDescription string

A textual description that can be presented to the user about what this transaction is doing.

const (
	TransactionValidationErrorDescriptionEmpty TransactionValidationErrorDescription = ""
)

func (TransactionValidationErrorDescription) IsKnown added in v0.7.3

type TransactionValidationErrorReason added in v0.7.3

type TransactionValidationErrorReason string

A textual description about the reasons the transaction was flagged with result_type.

const (
	TransactionValidationErrorReasonEmpty TransactionValidationErrorReason = ""
)

func (TransactionValidationErrorReason) IsKnown added in v0.7.3

type TransactionValidationErrorResultType added in v0.7.3

type TransactionValidationErrorResultType string

A string indicating if the transaction is safe to sign or not.

const (
	TransactionValidationErrorResultTypeError TransactionValidationErrorResultType = "Error"
)

func (TransactionValidationErrorResultType) IsKnown added in v0.7.3

type TransactionValidationErrorStatus added in v0.9.1

type TransactionValidationErrorStatus string

A string indicating if the simulation was successful or not.

const (
	TransactionValidationErrorStatusSuccess TransactionValidationErrorStatus = "Success"
)

func (TransactionValidationErrorStatus) IsKnown added in v0.9.1

type TransactionValidationResultType

type TransactionValidationResultType string

An enumeration.

const (
	TransactionValidationResultTypeBenign    TransactionValidationResultType = "Benign"
	TransactionValidationResultTypeWarning   TransactionValidationResultType = "Warning"
	TransactionValidationResultTypeMalicious TransactionValidationResultType = "Malicious"
)

func (TransactionValidationResultType) IsKnown

type TransactionValidationStatus added in v0.9.1

type TransactionValidationStatus string

A string indicating if the simulation was successful or not.

const (
	TransactionValidationStatusSuccess TransactionValidationStatus = "Success"
)

func (TransactionValidationStatus) IsKnown added in v0.9.1

func (r TransactionValidationStatus) IsKnown() bool

type TxScanRequestSchemaMetadataParam added in v0.12.0

type TxScanRequestSchemaMetadataParam struct {
	// URL of the dApp that originated the transaction
	URL param.Field[string] `json:"url"`
}

func (TxScanRequestSchemaMetadataParam) MarshalJSON added in v0.12.0

func (r TxScanRequestSchemaMetadataParam) MarshalJSON() (data []byte, err error)

type TxScanRequestSchemaParam added in v0.12.0

type TxScanRequestSchemaParam struct {
	// Encoded public key of the account to simulate the transaction on
	AccountAddress param.Field[string]                           `json:"account_address,required"`
	Metadata       param.Field[TxScanRequestSchemaMetadataParam] `json:"metadata,required"`
	// Transactions to scan
	Transactions param.Field[[]string] `json:"transactions,required"`
	// Chain to scan the transaction on
	Chain param.Field[string] `json:"chain"`
	// Encoding of the transaction and public keys
	Encoding param.Field[string] `json:"encoding"`
	// The RPC method used by dApp to propose the transaction
	Method  param.Field[string]   `json:"method"`
	Options param.Field[[]string] `json:"options"`
}

func (TxScanRequestSchemaParam) MarshalJSON added in v0.12.0

func (r TxScanRequestSchemaParam) MarshalJSON() (data []byte, err error)

type UsdDiff

type UsdDiff struct {
	In    string      `json:"in,required"`
	Out   string      `json:"out,required"`
	Total string      `json:"total,required"`
	JSON  usdDiffJSON `json:"-"`
}

func (*UsdDiff) UnmarshalJSON

func (r *UsdDiff) UnmarshalJSON(data []byte) (err error)

type ValidationFeature added in v0.27.0

type ValidationFeature struct {
	// Textual description
	Description string `json:"description,required"`
	// Feature name
	FeatureID string `json:"feature_id,required"`
	// An enumeration.
	Type ValidationFeatureType `json:"type,required"`
	// Address the feature refers to
	Address string                `json:"address,nullable"`
	JSON    validationFeatureJSON `json:"-"`
}

func (*ValidationFeature) UnmarshalJSON added in v0.27.0

func (r *ValidationFeature) UnmarshalJSON(data []byte) (err error)

type ValidationFeatureType added in v0.27.0

type ValidationFeatureType string

An enumeration.

const (
	ValidationFeatureTypeInfo      ValidationFeatureType = "Info"
	ValidationFeatureTypeBenign    ValidationFeatureType = "Benign"
	ValidationFeatureTypeWarning   ValidationFeatureType = "Warning"
	ValidationFeatureTypeMalicious ValidationFeatureType = "Malicious"
)

func (ValidationFeatureType) IsKnown added in v0.27.0

func (r ValidationFeatureType) IsKnown() bool

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL