bot

package module

Go to main page

Versions in this module

v3

v3.16.8

Jul 13, 2025

v3.16.7

Jul 11, 2025

Changes in this version

type ComputerDeployedAsset

+ ChainID string

+ Name string

+ PriceUsd string

+ Symbol string

+ func (c ComputerDeployedAsset) GetSolanaAssetId() string

v3.16.6

Jul 10, 2025

Changes in this version

+ const USDC_ARBITRUM

+ const USDC_OPTIMISM

v3.16.5

Jul 9, 2025

Changes in this version

+ const USDT_ARBITRUM

+ const USDT_OPTIMISM

v3.16.4

Jul 8, 2025

v3.16.3

Jul 7, 2025

Changes in this version

+ const ArbitrumChainId

+ const OptimismChainId

+ type BareUserKeyStore struct

+ AppId string

+ ServerPublicKey string

+ SessionId string

+ SessionPrivateKey string

+ SpentPrivateKey string

+ type KeystoreLegacy struct

+ Pin string

+ PinToken string

+ PrivateKey string

+ SessionId string

type User

+ ServerPublicKey string

+ func RegisterSafeBareUser(ctx context.Context, su *SafeUser) (*User, error)

+ type UserUpgrade struct

+ ServerPublicKeyHEX string

+ SessionId string

+ SessionPrivateKey string

+ UserId string

+ func UpgradeLegacyUser(ctx context.Context, kl *KeystoreLegacy) (*UserUpgrade, error)

v3.16.2

Jul 2, 2025

Changes in this version

+ func BuildSystemCallExtra(uid, cid string, skipProcess bool, fid string) ([]byte, error)

+ func ComputerUserIDToBytes(id string) ([]byte, error)

v3.16.1

Jun 30, 2025

Changes in this version

+ type ComputerSystemCall struct

+ Hash string

+ ID string

+ NonceAccount string

+ Raw string

+ State string

+ Type string

+ UserID string

type ComputerSystemCallResponse

+ SubCalls []ComputerSystemCall

v3.16.0

Jun 24, 2025

Changes in this version

+ const OperationTypeAddUser

+ const OperationTypeSystemCall

+ const OperationTypeUserDeposit

+ const SolanaChainID

+ func ComputerDeployExternalAsset(ctx context.Context, assets []string) error

+ func EncodeMtgExtra(appID string, extra []byte) string

+ func EncodeOperationMemo(operation byte, extra []byte) []byte

+ type ComputerDeployedAsset struct

+ Address string

+ AssetID string

+ Decimals int64

+ IconURL string

+ func GetComputerDeployedAssets(ctx context.Context) ([]*ComputerDeployedAsset, error)

+ type ComputerFeeResponse struct

+ FeeID string

+ XINAmount string

+ func GetFeeOnXINBasedOnSOL(ctx context.Context, solAmount string) (*ComputerFeeResponse, error)

+ type ComputerInfoResponse struct

+ Height int64

+ Members struct{ ... }

+ ObserverId string

+ Params struct{ ... }

+ Payer string

+ func GetComputerInfo(ctx context.Context) (*ComputerInfoResponse, error)

+ type ComputerNonceAccountResponse struct

+ Mix string

+ NonceAddress string

+ NonceHash string

+ func LockComputerNonceAccount(ctx context.Context, mix string) (*ComputerNonceAccountResponse, error)

+ type ComputerSystemCallResponse struct

+ Hash string

+ ID string

+ NonceAccount string

+ Raw string

+ Reason string

+ State string

+ UserID string

+ func GetComputerSystemCall(ctx context.Context, id string) (*ComputerSystemCallResponse, error)

+ type ComputerUserResponse struct

+ ChainAddress string

+ ID string

+ MixAddress string

+ func GetComputerUser(ctx context.Context, addr string) (*ComputerUserResponse, error)

type SequencerTransactionRequest

+ func RegisterComputer(ctx context.Context, su *SafeUser) (*SequencerTransactionRequest, error)

v3.15.1

Jun 19, 2025

Changes in this version

+ type Treasury struct

+ Ratio string

+ Recipient string

v3.15.0

Jun 18, 2025

Changes in this version

+ type Collection struct

+ AssetKey string

+ CollectionHash string

+ CreatedAt time.Time

+ Description string

+ IconURL string

+ KernelAssetID string

+ MinimumPrice string

+ Name string

+ Supply string

+ Symbol string

+ Treasury map[string]interface{}

+ Type string

+ Unit string

+ UpdatedAt time.Time

+ func ReadCollection(ctx context.Context, collectionHash string) (*Collection, error)

+ type Inscription struct

+ CollectionHash string

+ ContentType string

+ ContentURL string

+ CreatedAt time.Time

+ InscriptionHash string

+ OccupiedBy string

+ Owner string

+ Recipient string

+ Sequence int64

+ Type string

+ UpdatedAt time.Time

+ func ReadCollectionItems(ctx context.Context, collectionHash string) ([]*Inscription, error)

+ func ReadInscription(ctx context.Context, inscriptionHash string) (*Inscription, error)

+ type Membership struct

+ ExpiredAt time.Time

+ Plan string

type User

+ Membership Membership

v3.14.0

Jun 4, 2025

Changes in this version

+ const USDC_BSC

v3.13.0

Jun 2, 2025

Changes in this version

type SafeUser

+ IsSpendPrivateSum bool

v3.12.2

May 28, 2025

Changes in this version

+ const VaultaAssetId

+ type MessageWithSession struct

+ Category string

+ ConversationId string

+ CreatedAt time.Time

+ Data string

+ DataBase64 string

+ ExpireIn int64

+ MessageId string

+ QuoteMessageId string

+ RepresentativeId string

+ SessionId string

+ Silent bool

+ Source string

+ Status string

+ Type string

+ UpdatedAt time.Time

+ UserId string

+ func SafeNotifySnapshot(ctx context.Context, transactionHash string, outputIndex int64, ...) (*MessageWithSession, error)

v3.12.1

May 16, 2025

Changes in this version

type AssetNetwork

+ CollectionHash string

v3.12.0

May 15, 2025

Changes in this version

type Asset

+ Level int64

type AssetNetwork

+ Level int64

type SafeSnapshot

+ Level int64

v3.11.1

Mar 22, 2025

v3.11.0

Mar 18, 2025

Changes in this version

+ func EstimateStorageCost(extra []byte) common.Integer

type InvoiceEntry

+ func (e *InvoiceEntry) IsStorage() bool

type MixAddress

+ func StorageRecipient() *MixAddress

type MixinInvoice

+ func (mi *MixinInvoice) AddStorageEntry(traceId string, extra []byte)

v3.10.1

Feb 26, 2025

Changes in this version

type AssetNetwork

+ func (asset *AssetNetwork) GetSymbol() string

type SafeDepositPending

+ func FetchPendingSafeDeposits(ctx context.Context) ([]*SafeDepositPending, error)

v3.10.0

Feb 21, 2025

Changes in this version

type User

+ AppId string

v3.9.9

Feb 11, 2025

Changes in this version

+ const LightningChainId

v3.9.8

Feb 5, 2025

Changes in this version

type AssetTicker

+ func ReadAssetTickerWithOffset(ctx context.Context, assetId string, offset string) (*AssetTicker, error)

type SequencerTransactionRequest

+ func SendTransactionWithUtxosAndChangeOutputs(ctx context.Context, assetId string, recipients []*TransactionRecipient, ...) (*SequencerTransactionRequest, error)

v3.9.7

Jan 20, 2025

Changes in this version

+ type Memebership struct

+ ExpiredAt time.Time

+ Plan string

type SequencerTransactionRequest

+ func WithdrawalWithUtxos(ctx context.Context, ...) ([]*SequencerTransactionRequest, error)

type User

+ Memebership Memebership

v3.9.6

Jan 2, 2025

Changes in this version

+ const MixinInvoicePrefix

+ const MixinInvoiceVersion

+ const USDC_BASE

+ type InvoiceEntry struct

+ Amount common.Integer

+ AssetId uuid.UUID

+ Extra []byte

+ HashReferences []crypto.Hash

+ IndexReferences []byte

+ TraceId uuid.UUID

type MixAddress

+ func NewMixAddressFromBytesUnchecked(payload []byte) (*MixAddress, error)

+ func (ma *MixAddress) BytesUnchecked() []byte

+ type MixinInvoice struct

+ Entries []*InvoiceEntry

+ Recipient *MixAddress

+ func NewMixinInvoice(recipient string) *MixinInvoice

+ func NewMixinInvoiceFromString(s string) (*MixinInvoice, error)

+ func (mi *MixinInvoice) AddEntry(traceId, assetId string, amount common.Integer, extra []byte, ...)

+ func (mi *MixinInvoice) BytesUnchecked() []byte

+ func (mi *MixinInvoice) String() string

type TransactionReceiver

+ Destination string

+ Tag string

+ WithdrawalHash string

v3.9.5

Dec 12, 2024

Changes in this version

+ const MixinFeeUserId

type SequencerTransactionRequest

+ func WithdrawalWithFeeUtxos(ctx context.Context, ...) ([]*SequencerTransactionRequest, error)

v3.9.4

Dec 1, 2024

Changes in this version

type SafeDepositView

+ Destination string

+ Tag string

v3.9.3

Nov 19, 2024

v3.9.2

Nov 14, 2024

Changes in this version

+ type BotAuthCache interface

+ Delete func(key string) error

+ Get func(key string) ([]byte, error)

+ Put func(key string, value []byte) error

+ type BotAuthClient struct

+ Cache BotAuthCache

+ Logger *slog.Logger

+ SafeUser *SafeUser

+ func NewBotAuthClient(cache BotAuthCache, su *SafeUser, logger *slog.Logger) *BotAuthClient

+ func NewDefaultClient(su *SafeUser, logger *slog.Logger) *BotAuthClient

+ func (c *BotAuthClient) SignRequest(ctx context.Context, ts int64, botUserId string, r *http.Request) (string, error)

+ type MapCache struct

+ func NewMapCache() *MapCache

+ func (c *MapCache) Delete(key string) error

+ func (c *MapCache) Get(key string) ([]byte, error)

+ func (c *MapCache) Put(key string, value []byte) error

type User

+ func GetUsers(ctx context.Context, userIds []string, su *SafeUser) ([]*User, error)

v3.9.1

Oct 30, 2024

Changes in this version

type SequencerTransactionRequest

+ func SendTransferTransactionWithOutputs(ctx context.Context, assetId, receiver, amount string, utxos []*Output, ...) (*SequencerTransactionRequest, error)

v3.9.0

Oct 27, 2024

v3.8.9

Oct 21, 2024

v3.8.8

Oct 21, 2024

Changes in this version

type AssetNetwork

+ DisplayName string

+ DisplaySymbol string

v3.8.7

Oct 20, 2024

Changes in this version

type AssetNetwork

+ PrimitiveAssetId string

v3.8.6

Oct 14, 2024

v3.8.5

Oct 11, 2024

Changes in this version

+ const BaseChainId

v3.8.4

Oct 7, 2024

Changes in this version

+ const USDT_BSC

+ const USDT_POLYGON

v3.8.3

Sep 28, 2024

Changes in this version

type Asset

+ func (asset *Asset) GetSymbol() string

v3.8.2

Sep 27, 2024

Changes in this version

+ const USDC_SOLANA

+ const USDT_SOLANA

type Asset

+ func ListAssetWithBalance(ctx context.Context, su *SafeUser) ([]*Asset, error)

v3.8.1

Sep 23, 2024

Changes in this version

+ func CreateMultisigRawTx(ctx context.Context, asset crypto.Hash, senders, receivers []string, ...) (string, error)

+ func HmacSha1(hmacKey string, data []byte) string

+ func HmacSha256(key, data []byte) string

type Asset

+ func FetchAssets(ctx context.Context, assetIds []string, safeUser *SafeUser) ([]*Asset, error)

type BlazeClient

+ func NewBlazeClientWithSafeUser(user *SafeUser) *BlazeClient

v3.8.0

Sep 20, 2024

Changes in this version

type Asset

+ DisplayName string

+ DisplaySymbol string

+ func FetchNetworkAssets(ctx context.Context, assetIds []string, safeUser *SafeUser) ([]*Asset, error)

type SafeMultisigRequest

+ func CreateSafeMultisigRequest(ctx context.Context, request []*KernelTransactionRequestCreateRequest, ...) ([]*SafeMultisigRequest, error)

+ type SimpleAddress struct

+ Destination string

+ Tag string

+ func CheckAddress(ctx context.Context, asset, destination, tag string) (*SimpleAddress, error)

v3.7.9

Sep 11, 2024

Changes in this version

+ func SignAuthenticationTokenWithRequestID(method, uri, body, requestID string, su *SafeUser) (string, error)

v3.7.8

Sep 11, 2024

v3.7.7

Sep 2, 2024

v3.7.6

Aug 28, 2024

Changes in this version

type SequencerTransactionRequest

+ func SendTransactionWithChangeOutputs(ctx context.Context, assetId string, recipients []*TransactionRecipient, ...) (*SequencerTransactionRequest, error)

v3.7.5

Aug 13, 2024

Changes in this version

type Conversation

+ func UpdateParticipants(ctx context.Context, conversationId, action string, requests []Participant, ...) (*Conversation, error)

type SequencerTransactionRequest

+ func SendTransactionSplitChangeOutput(ctx context.Context, assetId string, recipients []*TransactionRecipient, ...) (*SequencerTransactionRequest, error)

v3.7.4

Aug 8, 2024

Changes in this version

type Conversation

+ CodeUrl string

+ func RotateConversation(ctx context.Context, conversationId string, user *SafeUser) (*Conversation, error)

v3.7.3

Aug 7, 2024

Changes in this version

+ func UserAssetBalance(ctx context.Context, userID, assetID, accessToken string) (common.Integer, error)

type Output

+ func ListOutputsByToken(ctx context.Context, membersHash string, threshold byte, assetId, state string, ...) ([]*Output, error)

+ func ListUnspentOutputsByToken(ctx context.Context, membersHash string, threshold byte, kernelAssetId string, ...) ([]*Output, error)

v3.7.2

Aug 3, 2024

Changes in this version

+ const MessageCategorySystemSafeInscription

type SequencerTransactionRequest

+ func SendTransactionWithOutputs(ctx context.Context, assetId string, recipients []*TransactionRecipient, ...) (*SequencerTransactionRequest, error)

+ type TransferSafeView struct

+ Amount string

+ AssetId string

+ CreatedAt time.Time

+ DepositHash string

+ InscriptionHash string

+ Memo string

+ OpponentId string

+ SnapshotId string

+ TransactionHash string

+ Type string

+ UserId string

v3.7.1

Jul 25, 2024

Changes in this version

+ type AppCardAction = AppButtonView

+ type AppCardView struct

+ Actions []AppCardAction

+ AppID string

+ CoverURL string

+ Description string

+ Shareable bool

+ Title string

type SafeMultisigRequest

+ RevokedBy string

+ type SystemConversationPayload struct

+ Action string

+ ParticipantId string

+ Role string

+ UserId string

v3.7.0

Jul 22, 2024

Changes in this version

+ func RequestGhostRecipientsWithTraceId(ctx context.Context, recipients []*TransactionRecipient, traceId string, ...) (map[int]*GhostKeys, error)

+ func SendKernelTransactionFromAccount(ctx context.Context, asset crypto.Hash, receivers []string, threshold byte, ...) string

type Output

+ func GetOutput(ctx context.Context, id string, u *SafeUser) (*Output, error)

type SafeUser

+ func NewSafeUser(userId, sessionId, sessionPrivateKey string) *SafeUser

type SequencerTransactionRequest

+ func SendTransactionUntilSufficient(ctx context.Context, assetId, receiver, amount, traceId string, extra []byte, ...) (*SequencerTransactionRequest, error)

+ type UtxoInsufficientError struct

+ OutputSize int

+ TotalInput common.Integer

+ TotalOutput common.Integer

+ func (ue *UtxoInsufficientError) Error() string

v3.6.0

Jun 22, 2024

Changes in this version

+ const XINAssetId

+ func BuildRawTransaction(ctx context.Context, asset crypto.Hash, utxos []*Output, ...) (*common.Transaction, error)

+ type OutputReceiverView struct

+ Destination string

+ Members []string

+ MembersHash string

+ Tag string

+ Threshold int

+ WithdrawalHash string

+ type SafeMultisigRequest struct

+ Amount string

+ AssetId string

+ CreatedAt time.Time

+ Extra string

+ InscriptionHash string

+ KernelAssetID string

+ RawTransaction string

+ Receivers []*OutputReceiverView

+ RequestID string

+ Senders []string

+ SendersHash string

+ SendersThreshold int64

+ Signers []string

+ TransactionHash string

+ Type string

+ UpdatedAt time.Time

+ Views []string

+ func FetchSafeMultisigRequest(ctx context.Context, idOrHash string, user *SafeUser) (*SafeMultisigRequest, error)

v3.5.1

May 29, 2024

Changes in this version

type Asset

+ CollectionHash string

type Output

+ InscriptionHash string

v3.5.0

May 10, 2024

Changes in this version

type MessageRequest

+ DataBase64 string

type MessageView

+ DataBase64 string

v3.4.9

May 7, 2024

v3.4.8

Apr 14, 2024

Changes in this version

+ const InscriptionModeDone

+ const InscriptionModeInstant

+ type InscriptionDeploy struct

+ Checksum string

+ Icon string

+ Mode uint8

+ Name string

+ Supply string

+ Symbol string

+ Treasury ...

+ Unit string

+ Version uint8

+ type InscriptionDistribute struct

+ Operation string

+ Sequence uint64

+ type InscriptionInscribe struct

+ Content string

+ Operation string

+ Recipient string

+ type InscriptionOccupy struct

+ Operation string

+ Sequence uint64

v3.4.7

Apr 8, 2024

Changes in this version

+ func RequestGhostRecipients(ctx context.Context, recipients []*TransactionRecipient, u *SafeUser) (map[int]*GhostKeys, error)

type TransactionReceiver

+ MembersHash crypto.Hash

v3.4.6

Apr 1, 2024

Changes in this version

+ type WithdrawalFee struct

+ Amount string

+ AssetId string

+ Type string

+ func RequestWithdrawalFees(ctx context.Context, asset string, user *SafeUser) ([]*WithdrawalFee, error)

v3.4.5

Mar 25, 2024

Changes in this version

+ type AssetFee struct

+ Amount string

+ AssetID string

+ Type string

+ func ReadAssetFee(ctx context.Context, assetId, destination string, su *SafeUser) ([]*AssetFee, error)

type SequencerTransactionRequest

+ func SendRawTransaction(ctx context.Context, requests []*KernelTransactionRequestCreateRequest, ...) ([]*SequencerTransactionRequest, error)

+ func VerifyRawTransaction(ctx context.Context, requests []*KernelTransactionRequestCreateRequest, ...) ([]*SequencerTransactionRequest, error)

v3.4.4

Mar 20, 2024

Changes in this version

type Error

+ func NotFoundError(ctx context.Context) Error

v3.4.3

Mar 7, 2024

Changes in this version

type AssetNetwork

+ AssetKey string

+ Balance string

+ Capitalization float64

+ ChainID string

+ ChangeBTC string

+ ChangeUSD string

+ Confirmations int

+ Destination string

+ Dust string

+ FeeAssetID string

+ KernelAssetID string

+ Liquidity string

+ MixinID string

+ Name string

+ Precision int

+ PriceBTC string

+ PriceUSD string

+ PriceUpdatedAt string

+ Reserve string

+ Tag string

+ WithdrawalMemoPossibility string

+ func ReadNetworkAssetsTop(ctx context.Context) ([]*AssetNetwork, error)

v3.4.2

Feb 27, 2024

Changes in this version

+ type AssetNetwork struct

+ Amount string

+ AssetID string

+ IconURL string

+ Symbol string

+ func ReadNetworkAssets(ctx context.Context) ([]*AssetNetwork, error)

+ type SafeDepositPending struct

+ Amount float64

+ AssetID string

+ AssetKey string

+ BlockHash string

+ BlockNumber int

+ ChainID string

+ Confirmations int

+ CreatedAt string

+ DepositID string

+ Destination string

+ Extra string

+ KernelAssetID string

+ OutputIndex int

+ Sender string

+ State string

+ Tag string

+ Threshold int

+ TransactionHash string

+ UpdatedAt string

+ func FetchSafeDeposit(ctx context.Context) ([]*SafeDepositPending, error)

v3.4.1

Feb 23, 2024

v3.4.0

Feb 23, 2024

Changes in this version

+ func PostMessageRequest(ctx context.Context, message *MessageRequest, user *SafeUser) error

v3.3.0

Feb 1, 2024

Changes in this version

type SequencerTransactionRequest

+ Receivers []*TransactionReceiver

+ Senders []string

+ SendersHash string

+ SendersThreshold uint8

+ Signers []string

+ func GetTransactionByIdWithSafeUser(ctx context.Context, requestId string, su *SafeUser) (*SequencerTransactionRequest, error)

+ func SendTransactionWithOutput(ctx context.Context, assetId string, recipients []*TransactionRecipient, ...) (*SequencerTransactionRequest, error)

+ type TransactionReceiver struct

+ MemberHash crypto.Hash

+ Members []string

+ Threshold uint8

v3.2.0

Jan 23, 2024

Changes in this version

+ type LegacySnapshot struct

+ Amount string

+ AssetId string

+ ClosingBalance string

+ Confirmations int64

+ CreatedAt time.Time

+ Fee struct{ ... }

+ Memo string

+ OpeningBalance string

+ OpponentId string

+ OpponentKey string

+ OpponentMultisigReceivers []string

+ OpponentMultisigThreshold int64

+ OutputIndex int64

+ Receiver string

+ Sender string

+ SnapshotAt time.Time

+ SnapshotHash string

+ SnapshotId string

+ State string

+ TraceId string

+ TransactionHash string

+ Type string

+ func NetworkSnapshot(ctx context.Context, snapshotId string) (*LegacySnapshot, error)

+ func NetworkSnapshotByToken(ctx context.Context, snapshotId, accessToken string) (*LegacySnapshot, error)

+ func SnapshotById(ctx context.Context, snapshotId string, uid, sid, sessionKey string) (*LegacySnapshot, error)

+ func SnapshotByToken(ctx context.Context, snapshotId string, accessToken string) (*LegacySnapshot, error)

+ func SnapshotByTraceId(ctx context.Context, traceId string, uid, sid, sessionKey string) (*LegacySnapshot, error)

+ func Snapshots(ctx context.Context, limit int, ...) ([]*LegacySnapshot, error)

+ func SnapshotsByToken(ctx context.Context, limit int, offset, assetId, order, accessToken string) ([]*LegacySnapshot, error)

+ type LegacySnapshotShort struct

+ Amount string

+ Asset struct{ ... }

+ CreatedAt time.Time

+ Memo string

+ OpponentId string

+ SnapshotHash string

+ SnapshotId string

+ Source string

+ State string

+ TraceId string

+ Type string

+ func NetworkSnapshots(ctx context.Context, limit int, offset, assetId, order string) ([]*LegacySnapshotShort, error)

+ func NetworkSnapshotsByToken(ctx context.Context, limit int, ...) ([]*LegacySnapshotShort, error)

v3.1.1

Jan 12, 2024

Changes in this version

type SequencerTransactionRequest

+ func SendTransferTransaction(ctx context.Context, assetId, receiver, amount, traceId string, extra []byte, ...) (*SequencerTransactionRequest, error)

v3.1.0

Jan 10, 2024

v3.0.0

Dec 25, 2023

Changes in this version

+ const AkashChainId

+ const AlgorandChainId

+ const AptosChainId

+ const ArweaveChainId

+ const AvalancheChainId

+ const BSCChainId

+ const BTC

+ const BinanceChainId

+ const BitSharesChainId

+ const BitcoinCashChainId

+ const BitcoinChainId

+ const BitcoinSVChainId

+ const BytomChainId

+ const BytomPoSChainId

+ const CosmosChainId

+ const DashChainId

+ const DecredChainId

+ const DogecoinChainId

+ const EOSChainId

+ const ETH

+ const EthereumChainId

+ const EthereumClassicChainId

+ const FilecoinChainId

+ const GrinChainId

+ const HandshakeChainId

+ const HorizenChainId

+ const KusamaChainId

+ const LitecoinChainId

+ const MVMChainId

+ const MassGridChainId

+ const MessageCategoryAppButtonGroup

+ const MessageCategoryAppCard

+ const MessageCategoryMessagePin

+ const MessageCategoryMessageRecall

+ const MessageCategoryPlainContact

+ const MessageCategoryPlainData

+ const MessageCategoryPlainImage

+ const MessageCategoryPlainLive

+ const MessageCategoryPlainLocation

+ const MessageCategoryPlainPost

+ const MessageCategoryPlainSticker

+ const MessageCategoryPlainText

+ const MessageCategoryPlainTranscript

+ const MessageCategorySystemAccountSnapshot

+ const MessageCategorySystemConversation

+ const MessageCategorySystemSafeSnapshot

+ const MixAddressPrefix

+ const MixAddressVersion

+ const MobileCoinChainId

+ const MoneroChainId

+ const NEMChainId

+ const NamecoinChainId

+ const NearChainId

+ const NervosChainId

+ const PolkadotChainId

+ const PolygonChainId

+ const PreferenceSourceAll

+ const PreferenceSourceContacts

+ const PreferenceSourceNobody

+ const RavencoinChainId

+ const RelationshipActionAdd

+ const RelationshipActionBlock

+ const RelationshipActionRemove

+ const RelationshipActionUnblock

+ const RelationshipActionUpdate

+ const RippleChainId

+ const SiacoinChainId

+ const SolanaChainId

+ const StarcoinChainId

+ const StellarChainId

+ const TIPAddressAdd

+ const TIPAddressRemove

+ const TIPCollectibleRequestSign

+ const TIPCollectibleRequestUnlock

+ const TIPEmergencyContactCreate

+ const TIPEmergencyContactRead

+ const TIPEmergencyContactRemove

+ const TIPMultisigRequestSign

+ const TIPMultisigRequestUnlock

+ const TIPOAuthApprove

+ const TIPOwnershipTransfer

+ const TIPPhoneNumberUpdate

+ const TIPProvisioningUpdate

+ const TIPRawTransactionCreate

+ const TIPSequencerRegister

+ const TIPTransferCreate

+ const TIPUserDeactivate

+ const TIPVerify

+ const TIPWithdrawalCreate

+ const TONChainId

+ const TRONChainId

+ const TezosChainId

+ const USDC_ERC20

+ const USDT_ERC20

+ const USDT_TRC20

+ const VCashChainId

+ const XDCChainId

+ const ZcashChainId

+ var DefaultApiHost = "https://api.mixin.one"

+ var DefaultBlazeHost = "blaze.mixin.one"

+ var Nil = uuid.Nil

+ var ZeromeshApiHost = "https://mixin-api.zeromesh.net"

+ var ZeromeshBlazeHost = "mixin-blaze.zeromesh.net"

+ func AesDecrypt(secret, b []byte) ([]byte, error)

+ func AesEncrypt(secret, b []byte) ([]byte, error)

+ func AssetBalance(ctx context.Context, assetId, uid, sid, sessionKey string) (common.Integer, error)

+ func AssetBalanceWithSafeUser(ctx context.Context, kernelAssetId string, su *SafeUser) (common.Integer, error)

+ func CallKernelRPC(ctx context.Context, user *SafeUser, method string, params ...interface{}) ([]byte, error)

+ func CancelMultisig(ctx context.Context, id string, su *SafeUser) error

+ func Chunked(source []interface{}, size int) [][]interface

+ func DecryptMessageData(data string, sessionId, private string) (string, error)

+ func DeleteAddress(ctx context.Context, addressId string, user *SafeUser) error

+ func EncryptEd25519PIN(pin string, iterator uint64, current *SafeUser) (string, error)

+ func EncryptMessageData(data string, sessions []*Session, privateKey string) (string, error)

+ func GenerateUserChecksum(sessions []*Session) string

+ func GetChainName(chainId string) string

+ func GetFullChains() map[string]bool

+ func HashMembers(ids []string) string

+ func IsChainId(id string) bool

+ func MakeUniqueStringSlice(ss []string) []string

+ func NewTransport(roundTripper http.RoundTripper, uid, sid, privateKey string) (*transport, error)

+ func OAuthGetAccessToken(ctx context.Context, clientID, clientSecret string, authorizationCode string, ...) (string, string, string, error)

+ func PayWithdrawalFee(ctx context.Context, traceId, feeId, amount string, u *SafeUser) (*common.VersionedTransaction, error)

+ func PostAcknowledgements(ctx context.Context, requests []*ReceiptAcknowledgementRequest, user *SafeUser) error

+ func PostMessage(ctx context.Context, ...) error

+ func PostMessages(ctx context.Context, messages []*MessageRequest, user *SafeUser) error

+ func PrivateKeyToCurve25519(curve25519Private *[32]byte, privateKey ed25519.PrivateKey)

+ func PublicKeyToCurve25519(publicKey ed25519.PublicKey) ([]byte, error)

+ func ReadCode[C Code](ctx context.Context, codeId string) (C, error)

+ func Request(ctx context.Context, method, path string, body []byte, accessToken string) ([]byte, error)

+ func RequestWithId(ctx context.Context, method, path string, body []byte, ...) ([]byte, error)

+ func SchemeApps(appID, action string, params map[string]string) string

+ func SchemeCodes(codeId string) string

+ func SchemeConversations(conversationID, userID string) string

+ func SchemePay(assetId, traceId, recipientId, memo string, amount number.Decimal) string

+ func SchemeSend(category SendSchemeCategory, data []byte, conversationID string) string

+ func SchemeSnapshots(snapshotId, traceId string) string

+ func SchemeTransfer(userId string) string

+ func SchemeUsers(userId string) string

+ func SetBaseUri(base string)

+ func SetBlazeUri(blaze string)

+ func SetUserAgent(ua string)

+ func SharedKey(public ed25519.PublicKey, private ed25519.PrivateKey) ([32]byte, error)

+ func SignAuthenticationToken(method, uri, body string, su *SafeUser) (string, error)

+ func SignAuthenticationTokenWithoutBody(method, uri string, user *SafeUser) (string, error)

+ func SignOauthAccessToken(appID, authorizationID, privateKey, method, uri, body, scp string, ...) (string, error)

+ func SimpleRequest(ctx context.Context, method, path string, body []byte) ([]byte, error)

+ func TIPBodyForSequencerRegister(userId, publicKey string) []byte

+ func TIPBodyForVerify(timestamp int64) []byte

+ func TIPMigrateBody(pub ed25519.PublicKey) string

+ func TipBody(s string) []byte

+ func TipBodyForAddressAdd(assetId string, publicKey, keyTag, name string) []byte

+ func TipBodyForEmergencyContactCreate(verificationId, code string) []byte

+ func TipBodyForOwnershipTransfer(userId string) []byte

+ func TipBodyForPhoneNumberUpdate(verificationId, code string) []byte

+ func TipBodyForProvisioningUpdate(deviceId string, secret string) []byte

+ func TipBodyForRawTransactionCreate(assetId string, opponentKey string, opponentReceivers []string, ...) []byte

+ func TipBodyForTransfer(assetId string, counterUserId string, amount number.Decimal, ...) []byte

+ func TipBodyForWithdrawalCreate(addressId string, amount, fee number.Decimal, traceId, memo string) []byte

+ func UniqueConversationId(userId, recipientId string) string

+ func UniqueObjectId(args ...string) string

+ func UnlockMultisig(ctx context.Context, id, pin string, su *SafeUser) error

+ func UpdatePin(ctx context.Context, oldEncryptedPin, encryptedPin string, su *SafeUser) error

+ func UpdateTipPin(ctx context.Context, pin, pubTip string, su *SafeUser) error

+ func UuidFromBytes(input []byte) (uuid.UUID, error)

+ func UuidFromString(id string) (uuid.UUID, error)

+ func UuidNewV4() uuid.UUID

+ func WithAPIKey(userId, sessionId, p string)

+ type Address struct

+ AddressId string

+ AssetId string

+ Destination string

+ Dust string

+ Fee string

+ Label string

+ Tag string

+ UpdatedAt string

+ func CreateAddress(ctx context.Context, in *AddressInput, user *SafeUser) (*Address, error)

+ func GetAddressesByAssetId(ctx context.Context, assetId string, user *SafeUser) ([]*Address, error)

+ func ReadAddress(ctx context.Context, addressId, user *SafeUser) (*Address, error)

+ type AddressInput struct

+ AssetId string

+ Destination string

+ Label string

+ Tag string

+ type App struct

+ AppId string

+ AppNumber string

+ Capabilities []string

+ Category string

+ CreatorId string

+ Description string

+ HomeURI string

+ IconURL string

+ IsVerified bool

+ Name string

+ RedirectURI string

+ ResourcePatterns []string

+ Type string

+ UpdatedAt time.Time

+ func Migrate(ctx context.Context, receiver string, user *SafeUser) (*App, error)

+ type AppButtonView struct

+ Action string

+ Color string

+ Label string

+ type Asset struct

+ Amount string

+ AssetID string

+ AssetKey string

+ Capitalization float64

+ ChainID string

+ ChangeBTC string

+ ChangeUSD string

+ Confirmations int64

+ Fee string

+ IconURL string

+ KernelAssetId string

+ Liquidity string

+ Name string

+ Precision int

+ PriceBTC string

+ PriceUSD string

+ Reserve string

+ SnapshotsCount int64

+ Symbol string

+ Type string

+ func AssetSearch(ctx context.Context, name string) ([]*Asset, error)

+ func ReadAsset(ctx context.Context, name string) (*Asset, error)

+ type AssetTicker struct

+ PriceBTC string

+ PriceUSD string

+ Type string

+ func ReadAssetTicker(ctx context.Context, assetId string) (*AssetTicker, error)

+ type Attachment struct

+ AttachmentId string

+ Type string

+ UploadUrl string

+ ViewURL string

+ func AttachmentShow(ctx context.Context, id string, user *SafeUser) (*Attachment, error)

+ func CreateAttachment(ctx context.Context, user *SafeUser) (*Attachment, error)

+ type Authenticator struct

+ PrivateKey string

+ Sid string

+ Uid string

+ func NewAuthenticator(uid, sid, privateKey string) *Authenticator

+ func (a *Authenticator) BuildJWT(method, uri, body string) (string, error)

+ type BlazeClient struct

+ func NewBlazeClient(uid, sid, key string) *BlazeClient

+ func (b *BlazeClient) Loop(ctx context.Context, listener BlazeListener) error

+ func (b *BlazeClient) SendAppButton(ctx context.Context, conversationId, recipientId, label, action, color string) error

+ func (b *BlazeClient) SendAppCard(ctx context.Context, ...) error

+ func (b *BlazeClient) SendContact(ctx context.Context, conversationId, recipientId, contactId string) error

+ func (b *BlazeClient) SendGroupAppButton(ctx context.Context, conversationId, recipientId string, ...) error

+ func (b *BlazeClient) SendMessage(ctx context.Context, ...) error

+ func (b *BlazeClient) SendPlainText(ctx context.Context, msg MessageView, content string) error

+ func (b *BlazeClient) SendPost(ctx context.Context, msg MessageView, content string) error

+ func (b *BlazeClient) SendRecallMessage(ctx context.Context, conversationId, recipientId, recallMessageId string) error

+ func (b *BlazeClient) SetupDailer(dailer *websocket.Dialer)

+ type BlazeListener interface

+ OnAckReceipt func(ctx context.Context, msg MessageView, userID string) error

+ OnMessage func(ctx context.Context, msg MessageView, userId string) error

+ SyncAck func() bool

+ type BlazeMessage struct

+ Action string

+ Data json.RawMessage

+ Error *Error

+ Id string

+ Params map[string]interface{}

+ type Code interface

+ type Conversation struct

+ Announcement string

+ Category string

+ ConversationId string

+ CreatedAt time.Time

+ CreatorId string

+ IconURL string

+ Name string

+ ParticipantSessions []ParticipantSessionView

+ Participants []Participant

+ func ConversationShow(ctx context.Context, conversationId string, user *SafeUser) (*Conversation, error)

+ func ConversationShowByToken(ctx context.Context, conversationId string, accessToken string) (*Conversation, error)

+ func CreateContactConversation(ctx context.Context, participantID string, user *SafeUser) (*Conversation, error)

+ func CreateConversation(ctx context.Context, category, conversationId string, ...) (*Conversation, error)

+ func JoinConversation(ctx context.Context, conversationId string, user *SafeUser) (*Conversation, error)

+ type DepositEntryView struct

+ ChainID string

+ Destination string

+ EntryID string

+ IsPrimary bool

+ Members []string

+ SafeSignature string

+ Tag string

+ Threshold int64

+ Type string

+ func CreateDepositEntry(ctx context.Context, chainID string, members []string, threshold int64, ...) ([]*DepositEntryView, error)

+ type Error struct

+ Code int

+ Description string

+ Extra interface{}

+ Status int

+ func AuthorizationError(ctx context.Context) Error

+ func BadDataError(ctx context.Context) Error

+ func BlazeServerError(ctx context.Context, err error) Error

+ func ForbiddenError(ctx context.Context) Error

+ func ServerError(ctx context.Context, err error) Error

+ func (sessionError Error) Error() string

+ type Fiat struct

+ Code string

+ Rate float64

+ func Fiats(ctx context.Context) ([]*Fiat, error)

+ func GetFiats(ctx context.Context) ([]*Fiat, error)

+ type GhostKeyRequest struct

+ Hint string

+ Index uint

+ Receivers []string

+ type GhostKeys struct

+ Keys []string

+ Mask string

+ Type string

+ func RequestSafeGhostKeys(ctx context.Context, gkr []*GhostKeyRequest, user *SafeUser) ([]*GhostKeys, error)

+ func (g GhostKeys) KeysSlice() []*crypto.Key

+ type ImageMessagePayload struct

+ AttachmentId string

+ Height int

+ MimeType string

+ Size int64

+ Thumbnail string

+ Width int

+ type KernelDepositView struct

+ Chain string

+ DepositHash string

+ DepositIndex int64

+ type KernelTransactionRequestCreateRequest struct

+ Raw string

+ RequestID string

+ type LiveMessagePayload struct

+ Height int

+ ThumbUrl string

+ Url string

+ Width int

+ type MessageRequest struct

+ Category string

+ ConversationId string

+ Data string

+ MessageId string

+ QuoteMessageId string

+ RecipientId string

+ RepresentativeId string

+ type MessageView struct

+ Category string

+ ConversationId string

+ CreatedAt time.Time

+ Data string

+ MessageId string

+ QuoteMessageId string

+ RepresentativeId string

+ Source string

+ Status string

+ UpdatedAt time.Time

+ UserId string

+ type MixAddress struct

+ Threshold byte

+ Version byte

+ func NewMainnetMixAddress(members []string, threshold byte) *MixAddress

+ func NewMixAddressFromString(s string) (*MixAddress, error)

+ func NewUUIDMixAddress(members []string, threshold byte) *MixAddress

+ func (ma *MixAddress) Members() []string

+ func (ma *MixAddress) RequestOrGenerateGhostKeys(ctx context.Context, outputIndex uint, u *SafeUser) (*GhostKeys, error)

+ func (ma *MixAddress) String() string

+ type MultisigRequest struct

+ Action string

+ Amount string

+ AssetId string

+ CodeId string

+ CreatedAt time.Time

+ Memo string

+ RawTransaction string

+ Receivers []string

+ RequestId string

+ Senders []string

+ Signers []string

+ State string

+ Threshold int64

+ TransactionHash string

+ Type string

+ UserId string

+ func CreateMultisig(ctx context.Context, action, raw string, su *SafeUser) (*MultisigRequest, error)

+ func ReadMultisigByCode(ctx context.Context, codeId string) (*MultisigRequest, error)

+ func SignMultisig(ctx context.Context, id, pin string, su *SafeUser) (*MultisigRequest, error)

+ type MultisigUTXO struct

+ Amount string

+ AssetId string

+ CreatedAt time.Time

+ Members []string

+ Memo string

+ OutputIndex int64

+ Sender string

+ SignedBy string

+ SignedTx string

+ State string

+ Threshold int64

+ TransactionHash string

+ Type string

+ UTXOId string

+ UpdatedAt time.Time

+ UserId string

+ func ReadMultisigs(ctx context.Context, limit int, offset, membersHash, threshold, state string, ...) ([]*MultisigUTXO, error)

+ func ReadMultisigsLegacy(ctx context.Context, limit int, offset string, user *SafeUser) ([]*MultisigUTXO, error)

+ type NetworkChain struct

+ ChainId string

+ DepositBlockHeight int64

+ ExternalBlockHeight int64

+ IconURL string

+ IsSynchronized bool

+ ManagedBlockHeight int64

+ Name string

+ Symbol string

+ Threshold int

+ Type string

+ WithdrawalFee string

+ WithdrawalPendingCount int64

+ WithdrawalTimestamp time.Time

+ func ReadNetworkChainById(ctx context.Context, chainId string) (*NetworkChain, error)

+ func ReadNetworkChains(ctx context.Context, chainId string) ([]*NetworkChain, error)

+ type Output struct

+ Amount string

+ AssetId string

+ CreatedAt time.Time

+ Deposit *KernelDepositView

+ Extra string

+ KernelAssetId string

+ Keys []string

+ Mask string

+ OutputID string

+ OutputIndex uint

+ Receivers []string

+ ReceiversHash string

+ ReceiversThreshold int64

+ RequestId string

+ Senders []string

+ SendersHash string

+ SendersThreshold int64

+ Sequence int64

+ SignedBy string

+ Signers []string

+ State string

+ TransactionHash string

+ Type string

+ func ListOutputs(ctx context.Context, membersHash string, threshold byte, assetId, state string, ...) ([]*Output, error)

+ func ListUnspentOutputs(ctx context.Context, membersHash string, threshold byte, kernelAssetId string, ...) ([]*Output, error)

+ type Participant struct

+ CreatedAt time.Time

+ Role string

+ UserId string

+ type ParticipantSessionView struct

+ PublicKey string

+ SessionId string

+ Type string

+ UserId string

+ type RecallMessagePayload struct

+ MessageId string

+ type ReceiptAcknowledgementRequest struct

+ MessageId string

+ Status string

+ type SafeDepositView struct

+ DepositHash string

+ DepositIndex int64

+ Sender string

+ type SafeSnapshot struct

+ Amount string

+ AssetID string

+ CreatedAt time.Time

+ Deposit *SafeDepositView

+ KernelAssetID string

+ Memo string

+ OpponentID string

+ RequestId string

+ SnapshotID string

+ TransactionHash string

+ Type string

+ UserID string

+ Withdrawal *SafeWithdrawalView

+ func SafeSnapshotById(ctx context.Context, snapshotId string, su *SafeUser) (*SafeSnapshot, error)

+ func SafeSnapshotByToken(ctx context.Context, snapshotId string, accessToken string) (*SafeSnapshot, error)

+ func SafeSnapshots(ctx context.Context, limit int, app, assetId, opponent, offset string, ...) ([]*SafeSnapshot, error)

+ func SafeSnapshotsByToken(ctx context.Context, limit int, ...) ([]*SafeSnapshot, error)

+ type SafeUser struct

+ ServerPublicKey string

+ SessionId string

+ SessionPrivateKey string

+ SpendPrivateKey string

+ UserId string

+ type SafeWithdrawalView struct

+ Receiver string

+ WithdrawalHash string

+ type SendSchemeCategory = string

+ const SendSchemeCategoryAppCard

+ const SendSchemeCategoryContact

+ const SendSchemeCategoryImage

+ const SendSchemeCategoryLive

+ const SendSchemeCategoryPost

+ const SendSchemeCategoryText

+ type SequencerTransactionRequest struct

+ Amount string

+ Asset string

+ CreatedAt time.Time

+ Extra string

+ RawTransaction string

+ RequestID string

+ SnapshotAt time.Time

+ SnapshotHash string

+ SnapshotID string

+ State string

+ TransactionHash string

+ UpdatedAt time.Time

+ Views []string

+ func CreateObjectStorageTransaction(ctx context.Context, extra []byte, traceId string, u *SafeUser) (*SequencerTransactionRequest, error)

+ func GetTransactionById(ctx context.Context, requestId string) (*SequencerTransactionRequest, error)

+ func SendTransaction(ctx context.Context, assetId string, recipients []*TransactionRecipient, ...) (*SequencerTransactionRequest, error)

+ func SendWithdrawal(ctx context.Context, assetId, destination, tag, amount, traceId string, ...) (*SequencerTransactionRequest, error)

+ type Session struct

+ PublicKey string

+ SessionID string

+ UserID string

+ type TipNodeData struct

+ Commitments []string

+ Identity string

+ func GetTipNodeByPath(ctx context.Context, path string) (*TipNodeData, error)

+ func GetTipNodeByPathWithRequestId(ctx context.Context, path, requestId string) (*TipNodeData, error)

+ type TransactionRecipient struct

+ Amount string

+ Destination string

+ MixAddress string

+ Tag string

+ type TransferView struct

+ Amount string

+ AssetId string

+ CounterUserId string

+ CreatedAt time.Time

+ Memo string

+ SnapshotId string

+ TraceId string

+ Type string

+ type Turn struct

+ Credential string

+ Url string

+ Username string

+ func GetTurnServer(ctx context.Context, su *SafeUser) ([]*Turn, error)

+ type User struct

+ AvatarURL string

+ CreatedAt string

+ DeviceStatus string

+ FullName string

+ HasSafe bool

+ IdentityNumber string

+ PINTokenBase64 string

+ Phone string

+ PinToken string

+ SessionId string

+ TIPKeyBase64 string

+ UserId string

+ func CreateUser(ctx context.Context, sessionSecret, fullName string, su *SafeUser) (*User, error)

+ func CreateUserSimple(ctx context.Context, sessionSecret, fullName string) (*User, error)

+ func GetUser(ctx context.Context, userId string, su *SafeUser) (*User, error)

+ func RegisterSafe(ctx context.Context, userId, publicKey, seed string, su *SafeUser) (*User, error)

+ func Relationship(ctx context.Context, userId, action string, su *SafeUser) (*User, error)

+ func RequestUserMe(ctx context.Context, su *SafeUser) (*User, error)

+ func SearchUser(ctx context.Context, mixinId string, su *SafeUser) (*User, error)

+ func UpdatePreference(ctx context.Context, messageSource, conversationSource, currency string, ...) (*User, error)

+ func UpdateUserMe(ctx context.Context, fullName, avatarBase64 string, su *SafeUser) (*User, error)

+ func UserMe(ctx context.Context, accessToken string) (*User, error)

+ func UserMeWithRequestID(ctx context.Context, accessToken, requestID string) (*User, error)

+ func VerifyPIN(ctx context.Context, pin string, user *SafeUser) (*User, error)

+ func VerifyPINTip(ctx context.Context, su *SafeUser) (*User, error)

+ type UserSession struct

+ Platform string

+ PublicKey string

+ SessionId string

+ UserId string

+ func FetchUserSession(ctx context.Context, users []string, su *SafeUser) ([]*UserSession, error)

+ type UtxoError struct

+ OutputSize int

+ TotalInput common.Integer

+ TotalOutput common.Integer

+ func (ue *UtxoError) Error() string

Other modules containing this package

github.com/MixinNetwork/bot-api-go-client

github.com/MixinNetwork/bot-api-go-client/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL