\HsmAPI

All URIs are relative to https://your_deployment.multibaas.com/api/v0

Method	HTTP request	Description
AddHsmConfig	Post /hsm/config	Add HSM config
AddHsmKey	Post /hsm/key	Add HSM key
CreateHsmKey	Post /hsm/key/new	Create HSM key
ListHsm	Get /hsm	List HSM configs and wallets
ListHsmWallets	Get /hsm/wallets	List HSM wallets
RemoveHsmConfig	Delete /hsm/config/{client_id}	Remove HSM config
RemoveHsmKey	Delete /hsm/key/{wallet_address}	Remove HSM key
SetLocalNonce	Post /chains/{chain}/hsm/nonce/{wallet_address}	Set local nonce
SignAndSubmitTransaction	Post /chains/{chain}/hsm/submit	Sign and submit transaction
SignData	Post /chains/{chain}/hsm/sign	Sign data

AddHsmConfig

BaseResponse AddHsmConfig(ctx).BaseAzureAccount(baseAzureAccount).Execute()

Add HSM config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	baseAzureAccount := *openapiclient.NewBaseAzureAccount("Label_example", "ClientID_example", "ClientSecret_example", "TenantID_example", "SubscriptionID_example", "BaseGroupName_example") // BaseAzureAccount | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.AddHsmConfig(context.Background()).BaseAzureAccount(baseAzureAccount).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.AddHsmConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AddHsmConfig`: BaseResponse
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.AddHsmConfig`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAddHsmConfigRequest struct via the builder pattern

Name	Type	Description	Notes
baseAzureAccount	BaseAzureAccount

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddHsmKey

BaseResponse AddHsmKey(ctx).AddKey(addKey).Execute()

Add HSM key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	addKey := *openapiclient.NewAddKey("ClientID_example", "KeyName_example", "KeyVersion_example", "VaultName_example") // AddKey | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.AddHsmKey(context.Background()).AddKey(addKey).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.AddHsmKey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `AddHsmKey`: BaseResponse
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.AddHsmKey`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiAddHsmKeyRequest struct via the builder pattern

Name	Type	Description	Notes
addKey	AddKey

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateHsmKey

CreateHsmKey200Response CreateHsmKey(ctx).CreateKey(createKey).Execute()

Create HSM key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	createKey := *openapiclient.NewCreateKey("ClientID_example", "KeyName_example", "VaultName_example", false) // CreateKey | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.CreateHsmKey(context.Background()).CreateKey(createKey).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.CreateHsmKey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateHsmKey`: CreateHsmKey200Response
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.CreateHsmKey`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateHsmKeyRequest struct via the builder pattern

Name	Type	Description	Notes
createKey	CreateKey

Return type

CreateHsmKey200Response

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListHsm

ListHsm200Response ListHsm(ctx).Execute()

List HSM configs and wallets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.ListHsm(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.ListHsm``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListHsm`: ListHsm200Response
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.ListHsm`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiListHsmRequest struct via the builder pattern

Return type

ListHsm200Response

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListHsmWallets

ListHsmWallets200Response ListHsmWallets(ctx).KeyName(keyName).KeyVersion(keyVersion).VaultName(vaultName).BaseGroupName(baseGroupName).ClientId(clientId).PublicAddress(publicAddress).Limit(limit).Offset(offset).Execute()

List HSM wallets

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	keyName := "keyName_example" // string | Filter wallets by a key name. (optional)
	keyVersion := "keyVersion_example" // string | Filter wallets by a key version. (optional)
	vaultName := "vaultName_example" // string | Filter wallets by a vault name. (optional)
	baseGroupName := "baseGroupName_example" // string | Filter wallets by a base group name. (optional)
	clientId := "clientId_example" // string | Filter wallets by a client ID. (optional)
	publicAddress := "publicAddress_example" // string | Filter wallets by a public address. (optional)
	limit := int64(789) // int64 |  (optional)
	offset := int64(789) // int64 |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.ListHsmWallets(context.Background()).KeyName(keyName).KeyVersion(keyVersion).VaultName(vaultName).BaseGroupName(baseGroupName).ClientId(clientId).PublicAddress(publicAddress).Limit(limit).Offset(offset).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.ListHsmWallets``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListHsmWallets`: ListHsmWallets200Response
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.ListHsmWallets`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListHsmWalletsRequest struct via the builder pattern

Name	Type	Description
keyName	string	Filter wallets by a key name.
keyVersion	string	Filter wallets by a key version.
vaultName	string	Filter wallets by a vault name.
baseGroupName	string	Filter wallets by a base group name.
clientId	string	Filter wallets by a client ID.
publicAddress	string	Filter wallets by a public address.
limit	int64
offset	int64

Return type

ListHsmWallets200Response

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveHsmConfig

BaseResponse RemoveHsmConfig(ctx, clientId).Execute()

Remove HSM config

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	clientId := "clientId_example" // string | The HSM client ID.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.RemoveHsmConfig(context.Background(), clientId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.RemoveHsmConfig``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RemoveHsmConfig`: BaseResponse
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.RemoveHsmConfig`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
clientId	string	The HSM client ID.

Other Parameters

Other parameters are passed through a pointer to a apiRemoveHsmConfigRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveHsmKey

BaseResponse RemoveHsmKey(ctx, walletAddress).Execute()

Remove HSM key

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	walletAddress := "walletAddress_example" // string | An Ethereum address.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.RemoveHsmKey(context.Background(), walletAddress).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.RemoveHsmKey``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `RemoveHsmKey`: BaseResponse
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.RemoveHsmKey`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
walletAddress	string	An Ethereum address.

Other Parameters

Other parameters are passed through a pointer to a apiRemoveHsmKeyRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetLocalNonce

BaseResponse SetLocalNonce(ctx, chain, walletAddress).SetNonceRequest(setNonceRequest).Execute()

Set local nonce

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	chain := openapiclient.ChainName("ethereum") // ChainName | The blockchain chain label.
	walletAddress := "walletAddress_example" // string | An Ethereum address.
	setNonceRequest := *openapiclient.NewSetNonceRequest() // SetNonceRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.SetLocalNonce(context.Background(), chain, walletAddress).SetNonceRequest(setNonceRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.SetLocalNonce``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SetLocalNonce`: BaseResponse
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.SetLocalNonce`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
chain	ChainName	The blockchain chain label.
walletAddress	string	An Ethereum address.

Other Parameters

Other parameters are passed through a pointer to a apiSetLocalNonceRequest struct via the builder pattern

Name	Type	Description	Notes

setNonceRequest | SetNonceRequest | |

Return type

BaseResponse

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SignAndSubmitTransaction

TransferEth200Response SignAndSubmitTransaction(ctx, chain).BaseTransactionToSign(baseTransactionToSign).Execute()

Sign and submit transaction

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	chain := openapiclient.ChainName("ethereum") // ChainName | The blockchain chain label.
	baseTransactionToSign := *openapiclient.NewBaseTransactionToSign(*openapiclient.NewBaseTransactionToSignTx(int64(123), "From_example", "Value_example", "Data_example", int64(123))) // BaseTransactionToSign | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.SignAndSubmitTransaction(context.Background(), chain).BaseTransactionToSign(baseTransactionToSign).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.SignAndSubmitTransaction``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SignAndSubmitTransaction`: TransferEth200Response
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.SignAndSubmitTransaction`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
chain	ChainName	The blockchain chain label.

Other Parameters

Other parameters are passed through a pointer to a apiSignAndSubmitTransactionRequest struct via the builder pattern

Name	Type	Description	Notes

baseTransactionToSign | BaseTransactionToSign | |

Return type

TransferEth200Response

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SignData

SignData200Response SignData(ctx, chain).HSMSignRequest(hSMSignRequest).Execute()

Sign data

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/curvegrid/multibaas-sdk-go"
)

func main() {
	chain := openapiclient.ChainName("ethereum") // ChainName | The blockchain chain label.
	hSMSignRequest := *openapiclient.NewHSMSignRequest("Address_example", "Data_example") // HSMSignRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.HsmAPI.SignData(context.Background(), chain).HSMSignRequest(hSMSignRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `HsmAPI.SignData``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SignData`: SignData200Response
	fmt.Fprintf(os.Stdout, "Response from `HsmAPI.SignData`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
chain	ChainName	The blockchain chain label.

Other Parameters

Other parameters are passed through a pointer to a apiSignDataRequest struct via the builder pattern

Name	Type	Description	Notes

hSMSignRequest | HSMSignRequest | |

Return type

SignData200Response

Authorization

cookie, bearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

HsmAPI.md

Latest commit

History

HsmAPI.md

File metadata and controls

\HsmAPI

AddHsmConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

AddHsmKey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateHsmKey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListHsm

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListHsmWallets

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveHsmConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RemoveHsmKey

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SetLocalNonce

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SignAndSubmitTransaction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

SignData

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers