types

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

type BucketMeta struct {
	// BucketInfo defines the information of the bucket.
	BucketInfo *storageType.BucketInfo `xml:"BucketInfo"`
	// Removed defines the bucket is deleted or not
	Removed bool `xml:"Removed"`
	// DeleteAt defines the block number when the bucket deleted.
	DeleteAt int64 `xml:"DeleteAt"`
	// DeleteReason defines the deleted reason of bucket
	DeleteReason string `xml:"DeleteReason"`
	// Operator defines the operator address of bucket
	Operator string `xml:"Operator"`
	// CreateTxHash defines the creation transaction hash of bucket
	CreateTxHash string `xml:"CreateTxHash"`
	// UpdateTxHash defines the update transaction hash of bucket
	UpdateTxHash string `xml:"UpdateTxHash"`
	// UpdateAt defines the block number when the bucket updated
	UpdateAt int64 `xml:"UpdateAt"`
	// UpdateTime defines the block number when the bucket updated
	UpdateTime int64 `xml:"UpdateTime"`
	// OffChainStatus represents the status of a bucket in the off-chain storage.
	// It is used to track the current state of the bucket with respect to off-chain operations,
	// 1 means 0001 -> OffChainStatusIsLimited is true
	// 0 means 0000 -> OffChainStatusIsLimited is false
	// For an explanation of the different OffChainStatus values, please visit:https://github.com/bnb-chain/greenfield-storage-provider/blob/9d7048ad33cf51a2f7eb347e2113c5d0cc45f970/modular/blocksyncer/modules/bucket/bucket_handle.go#L40
	OffChainStatus int32 `xml:"OffChainStatus"`
}

type BucketMetaWithVGF struct {
	// BucketInfo defines the information of the bucket.
	BucketInfo *storageType.BucketInfo `xml:"BucketInfo"`
	// Removed defines the bucket is deleted or not
	Removed bool `xml:"Removed"`
	// DeleteAt defines the block number when the bucket deleted.
	DeleteAt int64 `xml:"DeleteAt"`
	// DeleteReason defines the deleted reason of bucket
	DeleteReason string `xml:"DeleteReason"`
	// Operator defines the operator address of bucket
	Operator string `xml:"Operator"`
	// CreateTxHash defines the creation transaction hash of bucket
	CreateTxHash string `xml:"CreateTxHash"`
	// UpdateTxHash defines the update transaction hash of bucket
	UpdateTxHash string `xml:"UpdateTxHash"`
	// UpdateAt defines the block number when the bucket updated
	UpdateAt int64 `xml:"UpdateAt"`
	// UpdateTime defines the block number when the bucket updated
	UpdateTime int64 `xml:"UpdateTime"`
	// Vgf serve as a means of grouping global virtual groups.
	Vgf *GlobalVirtualGroupFamily `xml:"Vgf"`
	// OffChainStatus represents the status of a bucket in the off-chain storage.
	// It is used to track the current state of the bucket with respect to off-chain operations,
	// 1 means 0001 -> OffChainStatusIsLimited is true
	// 0 means 0000 -> OffChainStatusIsLimited is false
	// For an explanation of the different OffChainStatus values, please visit:https://github.com/bnb-chain/greenfield-storage-provider/blob/9d7048ad33cf51a2f7eb347e2113c5d0cc45f970/modular/blocksyncer/modules/bucket/bucket_handle.go#L40
	OffChainStatus int32 `xml:"OffChainStatus"`
}

type BuyQuotaOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type CancelCreateOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type CancelMigrateBucketOptions struct {
	TxOpts      *gnfdsdktypes.TxOption
	IsAsyncMode bool // indicate whether to create the bucket in asynchronous mode
}

type CancelUpdateObjectOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type ChallengeResult struct {
	IntegrityHash string        // the integrity hash of the challenged object
	PieceData     io.ReadCloser // the data of the segment/piece being challenged
	PiecesHash    []string      // the hashes of the object's segments/pieces
}

type ChallengeV2Result struct {
	XMLName         xml.Name `xml:"GetChallengeInfo"`
	Version         string   `xml:"version,attr"`
	ObjectID        string   `xml:"ObjectID"`        // ObjectID defines the object id of the challenge request
	RedundancyIndex string   `xml:"RedundancyIndex"` // RedundancyIndex defines the redundancy index of the challenge request
	PieceIndex      string   `xml:"PieceIndex"`      // PieceIndex defines the piece index of the challenge request
	IntegrityHash   string   `xml:"IntegrityHash"`   // IntegrityHash defines the integrity hash of the object
	PieceHash       string   `xml:"PieceHash"`       // PieceHash defines the return piece hashes of the object
	PieceData       string   `xml:"PieceData"`       // PieceData defines the return piece data of challenge request
}

type ComputeHashOptions struct {
	SegmentSize  uint64
	DataShards   uint32
	ParityShards uint32
}

type CreateBucketOptions struct {
	Visibility     storageTypes.VisibilityType // Visibility defines the bucket public status.
	TxOpts         *gnfdsdktypes.TxOption      // TxOpts defines the options to customize a transaction.
	PaymentAddress string                      // PaymentAddress indicates the HEX-encoded string of the payment address.
	ChargedQuota   uint64                      // ChargedQuota defines the read data that users are charged for, measured in bytes.
	IsAsyncMode    bool                        // indicate whether to create the bucket in asynchronous mode.
	Tags           *storageTypes.ResourceTags  // set tags when creating bucket
}

type CreateGroupOptions struct {
	Extra  string                     // Extra defines the extra meta for a group.
	TxOpts *gnfdsdktypes.TxOption     // TxOpts defines the options to customize a transaction.
	Tags   *storageTypes.ResourceTags // set tags when creating bucket
}

type CreateObjectOptions struct {
	Visibility          storageTypes.VisibilityType // Visibility defines the bucket public status.
	TxOpts              *gnfdsdktypes.TxOption      // TxOpts defines the options to customize a transaction.
	SecondarySPAccs     []sdk.AccAddress            // SecondarySPAccs indicates a list of secondary Storage Provider's addresses.
	ContentType         string                      // ContentType defines the content type of object.
	IsReplicaType       bool                        // IsReplicaType indicates whether the object uses REDUNDANCY_REPLICA_TYPE.
	IsAsyncMode         bool                        // IsAsyncMode indicate whether to create the object in asynchronous mode.
	IsSerialComputeMode bool                        // IsSerialComputeMode indicate whether to compute integrity hash in serial way or parallel way when creating an object.
	Tags                *storageTypes.ResourceTags  // set tags when creating bucket
}

type CreateStorageProviderOptions struct {
	ReadPrice             sdk.Dec  // ReadPrice defines the storage provider's read price, in bnb wei per charge byte.
	FreeReadQuota         uint64   // FreeReadQuota defines the free read quota of the SP.
	StorePrice            sdk.Dec  // StorePrice defines the store price of the SP, in bnb wei per charge byte.
	ProposalDepositAmount math.Int // ProposalDepositAmount defines the amount needed for a proposal.
	ProposalTitle         string
	ProposalSummary       string
	ProposalMetaData      string
	TxOpts                gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type DeleteBucketOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type DeleteGroupOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type DeleteObjectOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type DeletePolicyOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type EndPointOptions struct {
	Endpoint  string // Endpoint indicates the endpoint of sp.
	SPAddress string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type ErrResponse struct {
	XMLName    xml.Name `xml:"Error"`
	Code       string   `xml:"Code"`
	Message    string   `xml:"Message"`
	StatusCode int
}

type GetChallengeInfoOptions struct {
	Endpoint     string // Endpoint indicates the endpoint of sp
	SPAddress    string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
	UseV2version bool   // UseV2version indicates whether using of the v2 version get-challenge API
}

type GetObjectOptions struct {
	Range            string `url:"-" header:"Range,omitempty"` // Range support for downloading partial data.
	SupportResumable bool   // SupportResumable support resumable download. Resumable downloads refer to the capability of resuming interrupted or incomplete downloads from the point where they were paused or disrupted.
	PartSize         uint64 // PartSize indicate the resumable download's part size, download a large file in multiple parts. The part size is an integer multiple of the segment size.
}

type GetSecondaryPieceOptions struct {
	Endpoint  string // Endpoint indicates the endpoint of sp.
	SPAddress string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type GlobalVirtualGroupFamily struct {
	// Id is the identifier of the global virtual group family.
	Id uint32 `xml:"Id"`
	// PrimarySpId is the id of primary sp
	PrimarySpId uint32 `xml:"PrimarySpId"`
	// GlobalVirtualGroupIds is a list of identifiers of the global virtual groups associated with the family.
	GlobalVirtualGroupIds []uint32 `xml:"GlobalVirtualGroupIds"`
	// VirtualPaymentAddress is the payment address associated with the global virtual group family.
	VirtualPaymentAddress string `xml:"VirtualPaymentAddress"`
}

type GrantDepositForStorageProviderOptions struct {
	Expiration *time.Time            // Expiration defines the expiration time of grant.
	TxOpts     gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type GroupMembers struct {
	// Group defines the basic group info
	Group *storageType.GroupInfo `xml:"Group"`
	// Operator defines operator address of group
	Operator string `xml:"Operator"`
	// CreateAt defines the block number when the group created
	CreateAt int64 `xml:"CreateAt"`
	// CreateTime defines the timestamp when the group created
	CreateTime int64 `xml:"CreateTime"`
	// UpdateAt defines the block number when the group updated
	UpdateAt int64 `xml:"UpdateAt"`
	// UpdateTime defines the timestamp when the group updated
	UpdateTime int64 `xml:"UpdateTime"`
	// Removed defines the group is deleted or not
	Removed bool `xml:"Removed"`
	// AccountID defines the address of account
	AccountID string `xml:"AccountId"`
	// ExpirationTime is the user expiration time for this group
	ExpirationTime string `xml:"ExpirationTime"`
}

type GroupMembersPaginationOptions struct {
	// Limit determines the number of group data records to be returned.
	// If the limit is set to 0, it will default to 50.
	// If the limit exceeds 1000, only 1000 records will be returned.
	Limit      int64
	StartAfter string // StartAfter is used to input the user's account address for pagination purposes.
	Endpoint   string // indicates the endpoint of sp.
	SPAddress  string // indicates the HEX-encoded string of the sp address to be challenged.
}

type GroupMembersResult struct {
	// Groups defines the response of group member list
	Groups []*GroupMembers `xml:"Groups"`
}

type GroupMeta struct {
	// Group defines the basic group info
	Group *storageType.GroupInfo `xml:"Group"`
	// NumberOfMembers defines how many members in this group
	NumberOfMembers int64 `xml:"NumberOfMembers"`
	// Operator defines operator address of group
	Operator string `xml:"Operator"`
	// CreateAt defines the block number when the group created
	CreateAt int64 `xml:"CreateAt"`
	// CreateTime defines the timestamp when the group created
	CreateTime int64 `xml:"CreateTime"`
	// UpdateAt defines the block number when the group updated
	UpdateAt int64 `xml:"UpdateAt"`
	// UpdateTime defines the timestamp when the group updated
	UpdateTime int64 `xml:"UpdateTime"`
	// Removed defines the group is deleted or not
	Removed bool `xml:"Removed"`
}

type GroupsOwnerPaginationOptions struct {
	// Limit determines the number of group data records to be returned.
	// If the limit is set to 0, it will default to 50.
	// If the limit exceeds 1000, only 1000 records will be returned.
	Limit      int64
	StartAfter string // StartAfter is used to input the group id for pagination purposes.
	Owner      string // Owner defines the owner account address of groups, if owner is set to "", it will default to current user address.
	Endpoint   string // Endpoint indicates the endpoint of sp.
	SPAddress  string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type GroupsPaginationOptions struct {
	// Limit determines the number of group data records to be returned.
	// If the limit is set to 0, it will default to 50.
	// If the limit exceeds 1000, only 1000 records will be returned.
	Limit      int64
	StartAfter string // StartAfter is used to input the group id for pagination purposes.
	Account    string // Account defines the user account address, if it is set to "", it will default to the current user address.
	Endpoint   string // Endpoint indicates the endpoint of sp.
	SPAddress  string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type GroupsResult struct {
	// Groups defines the response of group member list
	Groups []*GroupMembers `xml:"Groups"`
}

type LeaveGroupOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type ListBucketsByBucketIDResponse struct {
	// Buckets defines the information of a bucket map
	Buckets map[uint64]*BucketMeta `xml:"Buckets"`
}

type ListBucketsByPaymentAccountOptions struct {
	Endpoint  string // Endpoint indicates the endpoint of sp.
	SPAddress string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type ListBucketsByPaymentAccountResult struct {
	// Buckets defines the list of bucket
	Buckets []*BucketMeta `xml:"Buckets"`
}

type ListBucketsOptions struct {
	ShowRemovedBucket bool   // ShowRemovedBucket determines whether to include buckets that have been marked as removed in the list. If set to false, these buckets will be skipped.
	Account           string // Account defines the user account address, if it is set to "", it will default to the current user address.
	Endpoint          string // Endpoint indicates the endpoint of sp.
	SPAddress         string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type ListBucketsResult struct {
	// Buckets defines the list of bucket
	Buckets []*BucketMetaWithVGF `xml:"Buckets"`
}

type ListGroupsByGroupIDResponse struct {
	// Groups defines the information of a group map
	Groups map[uint64]*GroupMeta `xml:"Groups"`
}

type ListGroupsOptions struct {
	SourceType string // SourceType indicates the source type of group.
	Limit      int64
	Offset     int64
	Endpoint   string // Endpoint indicates the endpoint of sp.
	SPAddress  string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type ListGroupsResult struct {
	// Groups defines the response of group list
	Groups []*GroupMeta `json:"Groups"`
	// Count defines total groups amount
	Count int64 `xml:"Count"`
}

type ListObjectPoliciesOptions struct {
	// Limit determines the number of policies data records to be returned.
	// If the limit is set to 0, it will default to 50.
	// If the limit exceeds 1000, only 1000 records will be returned.
	Limit      int64
	StartAfter string // StartAfter is used to input the policy id for pagination purposes.
	Endpoint   string // Endpoint indicates the endpoint of sp.
	SPAddress  string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type ListObjectPoliciesResponse struct {
	Policies []*PolicyMeta `xml:"Policies"`
}

type ListObjectsByObjectIDResponse struct {
	// objects defines the information of a object map
	Objects map[uint64]*ObjectMeta `xml:"Objects"`
}

type ListObjectsOptions struct {
	// ShowRemovedObject determines whether to include objects that have been marked as removed in the list.
	// If set to false, these objects will be skipped.
	ShowRemovedObject bool

	// StartAfter defines the starting object name for the listing of objects.
	// The listing will start from the next object after the one named in this attribute.
	StartAfter string

	// ContinuationToken is the token returned from a previous list objects request to indicate where
	// in the list of objects to resume the listing. This is used for pagination.
	ContinuationToken string

	// Delimiter is a character that is used to group keys.
	// All keys that contain the same string between the prefix and the first occurrence of the delimiter
	// are grouped under a single result element in common prefixes.
	// It is used for grouping keys, currently only '/' is supported.
	Delimiter string

	// Prefix limits the response to keys that begin with the specified prefix.
	// You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file
	// system uses folders.
	Prefix string

	// MaxKeys defines the maximum number of keys returned to the response body.
	// If not specified, the default value is 50.
	// The maximum limit for returning objects is 1000
	MaxKeys   uint64
	Endpoint  string // indicates the endpoint of sp.
	SPAddress string // indicates the HEX-encoded string of the sp address to be challenged.
}

type ListObjectsResult struct {
	// Objects defines the list of object
	Objects []*ObjectMeta `xml:"Objects"`
	// KeyCount is the number of keys returned with this request
	KeyCount string `xml:"KeyCount"`
	// MaxKeys sets the maximum number of keys returned to the response
	MaxKeys string `xml:"MaxKeys"`
	// IsTruncated set to false if all of the results were returned. set to true if more keys are available to return
	IsTruncated bool `xml:"IsTruncated"`
	// NextContinuationToken is sent when is_truncated is true, which means there are more keys in the bucket that can be listed
	NextContinuationToken string `xml:"NextContinuationToken"`
	// Name defines the name of the bucket
	Name string `xml:"Name"`
	// Prefix is the prefix used during the query
	Prefix string `xml:"Prefix"`
	// Delimiter is the delimiter used during the query
	Delimiter string `xml:"Delimiter"`
	// CommonPrefixes defines a list of strings representing common prefixes. common_prefixes are those parts of object key names that fall between the specified delimiters
	CommonPrefixes []string `xml:"CommonPrefixes"`
	// ContinuationToken is the continuation token used during the query
	ContinuationToken string `xml:"ContinuationToken"`
}

type ListReadRecordOptions struct {
	StartTimeStamp int64 // StartTimeStamp indicates the start timestamp of the return read quota record.
	MaxRecords     int
}

type ListUserPaymentAccountsOptions struct {
	Account   string // Account defines the user account address, if it is set to "", it will default to the current user address.
	Endpoint  string // Endpoint indicates the endpoint of sp.
	SPAddress string // SPAddress indicates the HEX-encoded string of the sp address to be challenged.
}

type ListUserPaymentAccountsResult struct {
	// PaymentAccount defines the list of payment accounts
	PaymentAccounts []*PaymentAccounts `xml:"PaymentAccounts"`
}

type MigrateBucketOptions struct {
	TxOpts      *gnfdsdktypes.TxOption
	IsAsyncMode bool // indicate whether to create the bucket in asynchronous mode
}

type MigrationProgress struct {
	XMLName             xml.Name `xml:"QueryMigrationProgress"`
	Version             string   `xml:"version,attr"`        // Version defines version info
	ProgressDescription string   `xml:"ProgressDescription"` // ProgressDescription defines a string message representing the upload progress.
	ErrorDescription    string   `xml:"ErrorDescription"`    // ErrorDescription defines a string message representing an upload error exception.
	MigratedBytes       uint64   `xml:"MigratedBytes"`
	MigrationState      uint64   `xml:"MigrationState"`
}

type NewStatementOptions struct {
	StatementExpireTime *time.Time
	LimitSize           uint64
}

type ObjectAndBucketIDs struct {
	IDs []uint64 `xml:"IDs"`
}

type ObjectDetail struct {
	ObjectInfo         *storagetypes.ObjectInfo  `protobuf:"bytes,1,opt,name=object_info" json:"object_info,omitempty"`
	GlobalVirtualGroup *types.GlobalVirtualGroup `protobuf:"bytes,2,opt,name=global_virtual_group" json:"global_virtual_group,omitempty"`
}

type ObjectMeta struct {
	// ObjectInfo defines the information of the object.
	ObjectInfo *storageType.ObjectInfo `xml:"ObjectInfo"`
	// LockedBalance defines locked balance of object
	LockedBalance string `xml:"LockedBalance"`
	// Removed defines the object is deleted or not
	Removed bool `xml:"Removed"`
	// UpdateAt defines the block number when the object updated
	UpdateAt int64 `xml:"UpdateAt"`
	// DeleteAt defines the block number when the object deleted
	DeleteAt int64 `xml:"DeleteAt"`
	// DeleteReason defines the deleted reason of object
	DeleteReason string `xml:"DeleteReason"`
	// Operator defines the operator address of object
	Operator string `xml:"Operator"`
	// CreateTxHash defines the creation transaction hash of object
	CreateTxHash string `xml:"CreateTxHash"`
	// UpdateTxHash defines the update transaction hash of object
	UpdateTxHash string `xml:"UpdateTxHash"`
	// SealTxHash defines the sealed transaction hash of object
	SealTxHash string `xml:"SealTxHash"`
}

type ObjectStat struct {
	ObjectName  string
	ContentType string
	Size        int64 // Object size
}

type PaymentAccount struct {
	// Address defines the address of payment account
	Address string `xml:"Address"`
	// Owner defines the owner of this payment account
	Owner string `xml:"Owner"`
	// Refundable defines the payment account is refundable or not
	Refundable bool `xml:"Refundable"`
	// UpdateAt defines the update block height of this payment account
	UpdateAt int64 `xml:"UpdateAt"`
	// UpdateTime defines the update time of this payment account
	UpdateTime int64 `xml:"UpdateTime"`
}

type PaymentAccounts struct {
	// refundable defines the payment account is refundable or not
	PaymentAccount *PaymentAccount `xml:"PaymentAccount"`
	// stream_records defines stream payment records of a stream account
	StreamRecord *StreamRecord `xml:"StreamRecord"`
}

type PolicyMeta struct {
	// PrincipalType defines the type of principal
	PrincipalType int32 `xml:"PrincipalType"`
	// PrincipalValue defines the value of principal
	PrincipalValue string `xml:"PrincipalValue"`
	// ResourceType defines the type of resource that grants permission for
	ResourceType int32 `xml:"ResourceType"`
	// ResourceId defines the bucket/object/group id of the resource that grants permission for
	ResourceId string `xml:"ResourceId"`
	// CreateTimestamp defines the create time of permission
	CreateTimestamp int64 `xml:"CreateTimestamp"`
	// UpdateTimestamp defines the update time of permission
	UpdateTimestamp int64 `xml:"UpdateTimestamp"`
	// ExpirationTime defines the expiration time of permission
	ExpirationTime int64 `xml:"ExpirationTime"`
}

type Principal string

type PutObjectOptions struct {
	ContentType      string // ContentType indicates the content type of object.
	TxnHash          string // TxnHash indicates the transaction hash creating the object meta on chain.
	DisableResumable bool   // DisableResumable indicates whether upload the object to Storage Provider via resumable upload.
	PartSize         uint64
	Delegated        bool // Delegated indicates that the request to SP will require SP to create/update objet behalf of the uploader.
	IsUpdate         bool // IsUpdate indicates that the request to SP is a delegated update object request.
	Visibility       storageTypes.VisibilityType
}

type PutPolicyOption struct {
	TxOpts           *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
	PolicyExpireTime *time.Time             // PolicyExpireTime defines the expiration timestamp of policy.
}

type QueryPieceInfo struct {
	ObjectId        string
	PieceIndex      int
	RedundancyIndex int
}

type QuotaInfo struct {
	XMLName                 xml.Name `xml:"GetReadQuotaResult"`
	Version                 string   `xml:"version,attr"`
	BucketName              string   `xml:"BucketName"`
	BucketID                string   `xml:"BucketID"`                 // BucketID defines the bucket read quota value on chain
	ReadQuotaSize           uint64   `xml:"ReadQuotaSize"`            // ReadQuotaSize defines the bucket read quota value on chain
	SPFreeReadQuotaSize     uint64   `xml:"SPFreeReadQuotaSize"`      // SPFreeReadQuotaSize defines the free quota of this month
	ReadConsumedSize        uint64   `xml:"ReadConsumedSize"`         // ReadConsumedSize defines the consumed total read quota of this month
	FreeConsumedSize        uint64   `xml:"FreeConsumedSize"`         // FreeConsumedSize defines the consumed free quota
	MonthlyFreeQuota        uint64   `xml:"MonthlyFreeQuota"`         // MonthlyFreeQuota defines the consumed monthly free quota
	MonthlyFreeConsumedSize uint64   `xml:"MonthlyQuotaConsumedSize"` // MonthlyFreeConsumedSize defines the consumed monthly free quota
}

type QuotaRecordInfo struct {
	XMLName xml.Name `xml:"GetBucketReadQuotaResult"`
	Version string   `xml:"version,attr"` // The Version defines version info
	// When using ListBucketReadRecord to list items, if the returned results do not cover all items, the NextStartTimestampUs will be returned to indicate the timestamp of the current traversal progress.
	// When you call the ListBucketReadRecord again, you can set opt.StartTimeStamp to this timestamp.
	NextStartTimestampUs int64 `xml:"NextStartTimestampUs"`
	// ReadRecords defines the result record list.
	ReadRecords []ReadRecord `xml:"ReadRecord"`
}

type ReadRecord struct {
	XMLName            xml.Name `xml:"ReadRecord"`
	ObjectName         string   `xml:"ObjectName"`         // ObjectName The download object name
	ObjectID           string   `xml:"ObjectID"`           // ObjectID The download object id
	ReadAccountAddress string   `xml:"ReadAccountAddress"` // ReadAccountAddress The sender address of the download request
	ReadTimestampUs    int64    `xml:"ReadTimestampUs"`    // ReadTimestampUs The download time stamp
	ReadSize           uint64   `xml:"ReadSize"`           // ReadSize The download object size
}

type RenewGroupMemberOption struct {
	TxOpts         *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
	ExpirationTime []*time.Time           // ExpirationTime defines a list of expiration time for each group member to be updated.
}

type SetBucketFlowRateLimitOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type SetTagsOptions struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type StorageProvider struct {
	Id              uint32
	OperatorAddress sdk.AccAddress
	FundingAddress  sdk.AccAddress
	SealAddress     sdk.AccAddress
	ApprovalAddress sdk.AccAddress
	GcAddress       sdk.AccAddress
	Status          spTypes.Status
	EndPoint        *url.URL
	Description     spTypes.Description
	BlsKey          []byte
}

type StreamRecord struct {
	// Account address
	Account string `xml:"Account"`
	// CrudTimestamp defines latest update timestamp of the stream record
	CrudTimestamp int64 `xml:"CrudTimestamp"`
	// NetflowRate defines The per-second rate that an account's balance is changing.
	// It is the sum of the account's inbound and outbound flow rates.
	NetflowRate int64 `xml:"NetflowRate"`
	// StaticBalance defines The balance of the stream account at the latest CRUD timestamp.
	StaticBalance int64 `xml:"StaticBalance"`
	// BufferBalance defines reserved balance of the stream account
	// If the netflow rate is negative, the reserved balance is `netflow_rate * reserve_time`
	BufferBalance int64 `xml:"BufferBalance"`
	// LockBalance defines the locked balance of the stream account after it puts a new object and before the object is sealed
	LockBalance int64 `xml:"LockBalance"`
	// Status defines the status of the stream account
	Status int32 `xml:"Status"`
	// SettleTimestamp defines the unix timestamp when the stream account will be settled
	SettleTimestamp int64 `xml:"SettleTimestamp"`
	// OutFlowCount defines the count of its out flows
	OutFlowCount uint64 `xml:"OutFlowCount"`
	// FrozenNetflowRate defines the frozen netflow rate, which is used when resuming stream account
	FrozenNetflowRate int64 `xml:"FrozenNetflowRate"`
}

type SubmitProposalOptions struct {
	Metadata string                // metadata efines the metadata to be submitted along with the proposal.
	TxOpts   gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type TransferDetail struct {
	ToAddress string
	Amount    math.Int
}

type UpdateBucketOptions struct {
	Visibility     storageTypes.VisibilityType // Visibility defines the bucket public status.
	TxOpts         *gnfdsdktypes.TxOption      // TxOpts defines the options to customize a transaction.
	PaymentAddress string                      // PaymentAddress defines the HEX-encoded string of the payment address.
	ChargedQuota   *uint64                     // ChargedQuota defines the read data that users are charged for, measured in bytes.
}

type UpdateGroupMemberOption struct {
	TxOpts         *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
	ExpirationTime []*time.Time           // ExpirationTime defines a list of expiration time for each group member to be updated.
}

type UpdateObjectOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type UpdateObjectOptions struct {
	TxOpts              *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
	SecondarySPAccs     []sdk.AccAddress       // SecondarySPAccs indicates a list of secondary Storage Provider's addresses.
	ContentType         string                 // ContentType defines the content type of object.
	IsReplicaType       bool                   // IsReplicaType indicates whether the object uses REDUNDANCY_REPLICA_TYPE.
	IsAsyncMode         bool                   // IsAsyncMode indicate whether to update the object in asynchronous mode.
	IsSerialComputeMode bool                   // IsSerialComputeMode indicate whether to compute integrity hash in serial way or parallel way when creating an object.
}

type UpdatePaymentOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type UpdateVisibilityOption struct {
	TxOpts *gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}

type UploadOffset struct {
	XMLName xml.Name `xml:"QueryResumeOffset"`
	Version string   `xml:"version,attr"` // Version defines version info
	Offset  uint64   `xml:"Offset"`       // Offset defines the offset info of resumable uploading object
}

type UploadProgress struct {
	XMLName             xml.Name `xml:"QueryUploadProgress"`
	Version             string   `xml:"version,attr"`        // Version defines version info
	ProgressDescription string   `xml:"ProgressDescription"` // ProgressDescription defines a string message representing the upload progress.
	ErrorDescription    string   `xml:"ErrorDescription"`    // ErrorDescription defines a string message representing an upload error exception.
}

type VoteProposalOptions struct {
	Metadata string                // Metadata defines the metadata to be submitted along with the vote.
	TxOpts   gnfdsdktypes.TxOption // TxOpts defines the options to customize a transaction.
}