paymaster

type AccountDeploymentData struct {
	// The expected address to be deployed, used to double check
	Address *felt.Felt `json:"address"`
	// The hash of the deployed contract's class
	ClassHash *felt.Felt `json:"class_hash"`
	// The salt used for the contract address calculation
	Salt *felt.Felt `json:"salt"`
	// The parameters passed to the constructor
	Calldata []*felt.Felt `json:"calldata"`
	// Optional array of felts to be added to the signature
	SignatureData []*felt.Felt `json:"sigdata,omitempty"`
	// The Cairo version of the account contract. Cairo 0 is not supported.
	Version CairoVersion `json:"version"`
}

type BuildTransactionRequest struct {
	// The transaction to be executed by the paymaster
	Transaction UserTransaction `json:"transaction"`
	// Execution parameters to be used when executing the transaction
	Parameters UserParameters `json:"parameters"`
}

type BuildTransactionResponse struct {
	// The type of the transaction
	Type UserTxnType `json:"type"`
	// The deployment data for `deploy` and `deploy_and_invoke` transaction types.
	// It's `nil` for `invoke` transaction types.
	Deployment *AccountDeploymentData `json:"deployment,omitempty"`
	// Execution parameters to be used when executing the transaction
	Parameters *UserParameters `json:"parameters"`
	// The typed data for for `invoke` and `deploy_and_invoke` transaction types.
	// It's `nil` for `deploy` transaction types.
	TypedData *typeddata.TypedData `json:"typed_data,omitempty"`
	// The fee estimation for the transaction
	Fee *FeeEstimate `json:"fee"`
}

type CairoVersion int

type Call struct {
	// The address of the contract to invoke
	To *felt.Felt `json:"to"`
	// The selector of the function to invoke
	Selector *felt.Felt `json:"selector"`
	// The parameters passed to the function
	Calldata []*felt.Felt `json:"calldata"`
}

type ExecutableUserInvoke struct {
	// The address of the user account
	UserAddress *felt.Felt `json:"user_address"`
	// Typed data returned by the endpoint paymaster_buildTransaction
	TypedData *typeddata.TypedData `json:"typed_data"`
	// Signature of the associated Typed Data
	Signature []*felt.Felt `json:"signature"`
}

type ExecutableUserTransaction struct {
	// The type of the transaction to be executed by the paymaster
	Type UserTxnType `json:"type"`
	// The deployment data for the transaction, used for `deploy` and
	// `deploy_and_invoke` transaction types.
	// Should be `nil` for `invoke` transaction types.
	Deployment *AccountDeploymentData `json:"deployment,omitempty"`
	// Invoke data signed by the user to be executed by the paymaster service, used for`invoke` and
	// `deploy_and_invoke` transaction types.
	// Should be `nil` for `deploy` transaction types.
	Invoke *ExecutableUserInvoke `json:"invoke,omitempty"`
}

type ExecuteTransactionRequest struct {
	// Typed data build by calling paymaster_buildTransaction signed by the
	// user to be executed by the paymaster service
	Transaction ExecutableUserTransaction `json:"transaction"`
	// Execution parameters to be used when executing the transaction
	Parameters UserParameters `json:"parameters"`
}

type ExecuteTransactionResponse struct {
	// A unique identifier used to track an execution request of a user. Its purpose is to track
	// possibly different transactions sent by the paymaster and which are associated with a same
	// user request. Such cases can happen during congestion, where a fee or tip bump may be needed
	// in order for a transaction to enter a block
	TrackingID      *felt.Felt `json:"tracking_id"`
	TransactionHash *felt.Felt `json:"transaction_hash"`
}

type FeeEstimate struct {
	GasTokenPriceInStrk       *felt.Felt `json:"gas_token_price_in_strk"`
	EstimatedFeeInStrk        *felt.Felt `json:"estimated_fee_in_strk"`
	EstimatedFeeInGasToken    *felt.Felt `json:"estimated_fee_in_gas_token"`
	SuggestedMaxFeeInStrk     *felt.Felt `json:"suggested_max_fee_in_strk"`
	SuggestedMaxFeeInGasToken *felt.Felt `json:"suggested_max_fee_in_gas_token"`
}

type FeeMode struct {
	// The fee mode type to use for the transaction
	Mode FeeModeType `json:"mode"`
	// The gas token to use for the transaction. Should be omitted for `sponsored` fee mode
	GasToken *felt.Felt `json:"gas_token,omitempty"`
	// Relative tip priority or a custom tip value. If not provided/is `nil`,
	// the paymaster will use the `normal` tip priority by default.
	Tip *TipPriority `json:"tip,omitempty"`
}

type FeeModeType int

type Paymaster struct {
	// contains filtered or unexported fields
}

type RPCError = rpcerr.RPCError

type StringErrData = rpcerr.StringErrData

type TimeBounds struct {
	// A lower bound after which an outside call is valid in UNIX timestamp format
	ExecuteAfter string `json:"execute_after"`
	// An upper bound before which an outside call is valid in UNIX timestamp format
	ExecuteBefore string `json:"execute_before"`
}

type TipPriority struct {
	// The relative tip priority
	Priority TipPriorityEnum `json:"-"`
	// A custom tip value
	Custom *uint64 `json:"custom,omitempty"`
}

type TipPriorityEnum int

type TokenData struct {
	// Token contract address
	TokenAddress *felt.Felt `json:"token_address"`
	// The number of decimals of the token
	Decimals uint8 `json:"decimals"`
	// Price in STRK (in FRI units)
	PriceInStrk string `json:"price_in_strk"` // u256 as a hex string
}

type TrackingIDResponse struct {
	// The hash of the most recent tx sent by the paymaster and corresponding to the ID
	TransactionHash *felt.Felt `json:"transaction_hash"`
	// The status of the transaction associated with the ID
	Status TxnStatus `json:"status"`
}

type TxnExecutionErrData struct {
	ExecutionError string `json:"execution_error"`
}

type TxnStatus int

type UserInvoke struct {
	// The address of the user account
	UserAddress *felt.Felt `json:"user_address"`
	// The sequence of calls that the user wishes to perform
	Calls []Call `json:"calls"`
}

type UserParamVersion int

type UserParameters struct {
	// Version of the execution parameters which is not tied to the 'execute from outside' version.
	Version UserParamVersion `json:"version"`
	// Fee mode to use for the execution
	FeeMode FeeMode `json:"fee_mode"`
	// Optional. Time constraint on the execution
	TimeBounds *TimeBounds `json:"time_bounds"`
}

type UserTransaction struct {
	// The type of the transaction to be executed by the paymaster
	Type UserTxnType `json:"type"`
	// The deployment data for the transaction, used for `deploy` and
	// `deploy_and_invoke` transaction types.
	// Should be `nil` for `invoke` transaction types.
	Deployment *AccountDeploymentData `json:"deployment,omitempty"`
	// The invoke data for the transaction, used for `invoke` and
	// `deploy_and_invoke` transaction types.
	// Should be `nil` for `deploy` transaction types.
	Invoke *UserInvoke `json:"invoke,omitempty"`
}

type UserTxnType int