client

Documentation

Index

• Variables
• type AuthSecretKey
  • func (k AuthSecretKey) Sign(timestamp time.Time, data []byte) (AuthSignature, error)
• type AuthSignature
  • func (s AuthSignature) String() string
• type Chain
• type Client
  • func NewClient(options ClientOptions) (Client, error)
• type ClientOptions
  • func NewClientOptions() ClientOptions
• type CreateWalletOptions
  • func NewCreateWalletOptions() CreateWalletOptions
• type ListWalletsOptions
  • func NewListWalletsOptions() ListWalletsOptions
• type ListWalletsResult
• type SignOptions
  • func NewSignOptions() SignOptions
• type SignResult
• type UpdateWalletOptions
  • func NewUpdateWalletOptions() UpdateWalletOptions
• type VaultStatus
• type Wallet

Variables

var ErrNotImplemented = errors.New("not implemented")

Types

type AuthSecretKey

type AuthSecretKey string

func (AuthSecretKey) Sign

func (k AuthSecretKey) Sign(timestamp time.Time, data []byte) (AuthSignature, error)

type AuthSignature

type AuthSignature string

func (AuthSignature) String

func (s AuthSignature) String() string

type Chain

type Chain string

const (
	ChainLocal      Chain = "local"
	ChainEthereum   Chain = "ethereum"
	ChainSepolia    Chain = "sepolia"
	ChainBSC        Chain = "bsc"
	ChainBSCTestnet Chain = "bsc-testnet"
	ChainPolygon    Chain = "polygon"
	ChainAmoy       Chain = "amoy"
	ChainAvalanche  Chain = "avalanche"
	ChainFuji       Chain = "fuji"
)

type Client

type Client interface {
	URL() string
	APIKey() string
	VaultID() string
	AuthSecretKey() *AuthSecretKey

	Sign(ctx context.Context, options SignOptions) (SignResult, error)

	CreateWallet(ctx context.Context, options CreateWalletOptions) (Wallet, error)
	GetWallet(ctx context.Context, address common.Address) (Wallet, error)
	ListWallets(ctx context.Context, options ListWalletsOptions) (ListWalletsResult, error)
	UpdateWallet(ctx context.Context, address common.Address, options UpdateWalletOptions) (Wallet, error)
	ExpireWallet(ctx context.Context, address common.Address) (Wallet, error)
	UnexpireWallet(ctx context.Context, address common.Address) (Wallet, error)

	VaultStatus(ctx context.Context) (VaultStatus, error)
}

func NewClient

func NewClient(options ClientOptions) (Client, error)

type ClientOptions

type ClientOptions interface {
	URL() *string
	SetURL(url string) ClientOptions
	UnsetURL() ClientOptions

	APIKey() string
	SetAPIKey(apiKey string) ClientOptions

	VaultID() string
	SetVaultID(vaultId string) ClientOptions

	AuthSecretKey() *AuthSecretKey
	SetAuthSecretKey(authSecretKey AuthSecretKey) ClientOptions
	SetAuthSecretKeyFromString(authSecretKey string) ClientOptions
	SetAuthSecretKeyFromEnv() ClientOptions
}

func NewClientOptions

func NewClientOptions() ClientOptions

type CreateWalletOptions

type CreateWalletOptions interface {
	Name() string
	SetName(name string) CreateWalletOptions
}

func NewCreateWalletOptions

func NewCreateWalletOptions() CreateWalletOptions

type ListWalletsOptions

type ListWalletsOptions interface {
	Offset() *int64
	SetOffset(offset int64) ListWalletsOptions

	Count() *int64
	SetCount(count int64) ListWalletsOptions
}

func NewListWalletsOptions

func NewListWalletsOptions() ListWalletsOptions

type ListWalletsResult

type ListWalletsResult interface {
	Count() int64
	Page() []Wallet
}

type SignOptions

type SignOptions interface {
	Chain() Chain
	SetChain(chain Chain) SignOptions

	Contract() common.Address
	SetContract(contract common.Address) SignOptions

	Sender() common.Address
	SetSender(sender common.Address) SignOptions

	Uniq() *[]byte
	SetUniq(uniq []byte) SignOptions
	UnsetUniq() SignOptions

	Signer() *common.Address
	SetSigner(signer common.Address) SignOptions
	UnsetSigner() SignOptions

	ABI() map[string]any
	SetABI(abi map[string]any) SignOptions

	Args() []any
	SetArgs(args []any) SignOptions
}

func NewSignOptions

func NewSignOptions() SignOptions

type SignResult

type SignResult interface {
	SubmissionHash() string
	Args() []any
}

type UpdateWalletOptions

type UpdateWalletOptions interface {
	Name() string
	SetName(name string) UpdateWalletOptions
}

func NewUpdateWalletOptions

func NewUpdateWalletOptions() UpdateWalletOptions

type VaultStatus

type VaultStatus interface {
	Timestamp() time.Time
	Online() bool
	VaultKeys() int64
	Wallets() int64
	Version() string
}

type Wallet

type Wallet interface {
	ID() string
	Account() string
	Vault() string
	Name() string
	Address() common.Address
	Created() time.Time
	Updated() time.Time
	Expires() *time.Time
}