Documentation ¶
Index ¶
- Constants
- func AddAllUTXOs(ctx context.Context, utxos UTXOs, client UTXOClient, codec codec.Manager, ...) error
- type ChainUTXOs
- type UTXOClient
- type UTXOs
- type Wallet
- func NewWallet(p p.Wallet, x x.Wallet) Wallet
- func NewWalletFromURI(ctx context.Context, uri string, kc *secp256k1fx.Keychain) (Wallet, error)
- func NewWalletWithOptions(w Wallet, options ...common.Option) Wallet
- func NewWalletWithState(uri string, pCTX p.Context, xCTX x.Context, utxos UTXOs, ...) Wallet
- func NewWalletWithTxs(ctx context.Context, uri string, kc *secp256k1fx.Keychain, ...) (Wallet, error)
- func NewWalletWithTxsAndState(uri string, pCTX p.Context, xCTX x.Context, utxos UTXOs, ...) Wallet
Examples ¶
Constants ¶
const ( MainnetAPIURI = "https://api.avax.network" FujiAPIURI = "https://api.avax-test.network" LocalAPIURI = "http://localhost:9650" )
Variables ¶
This section is empty.
Functions ¶
func AddAllUTXOs ¶
func AddAllUTXOs( ctx context.Context, utxos UTXOs, client UTXOClient, codec codec.Manager, sourceChainID ids.ID, destinationChainID ids.ID, addrs []ids.ShortID, ) error
AddAllUTXOs fetches all the UTXOs referenced by [addresses] that were sent from [sourceChainID] to [destinationChainID] from the [client]. It then uses codec to parse the returned UTXOs and it adds them into [utxos]. If [ctx] expires, then the returned error will be immediately reported.
Types ¶
type ChainUTXOs ¶
type ChainUTXOs interface { AddUTXO(ctx context.Context, destinationChainID ids.ID, utxo *avax.UTXO) error RemoveUTXO(ctx context.Context, sourceChainID, utxoID ids.ID) error UTXOs(ctx context.Context, sourceChainID ids.ID) ([]*avax.UTXO, error) GetUTXO(ctx context.Context, sourceChainID, utxoID ids.ID) (*avax.UTXO, error) }
func NewChainUTXOs ¶
func NewChainUTXOs(chainID ids.ID, utxos UTXOs) ChainUTXOs
type UTXOClient ¶
type UTXOs ¶
type UTXOs interface { AddUTXO(ctx context.Context, sourceChainID, destinationChainID ids.ID, utxo *avax.UTXO) error RemoveUTXO(ctx context.Context, sourceChainID, destinationChainID, utxoID ids.ID) error UTXOs(ctx context.Context, sourceChainID, destinationChainID ids.ID) ([]*avax.UTXO, error) GetUTXO(ctx context.Context, sourceChainID, destinationChainID, utxoID ids.ID) (*avax.UTXO, error) }
func FetchState ¶
type Wallet ¶
Wallet provides chain wallets for the primary network.
Example ¶
ctx := context.Background() kc := secp256k1fx.NewKeychain(genesis.EWOQKey) // NewWalletFromURI fetches the available UTXOs owned by [kc] on the network // that [LocalAPIURI] is hosting. walletSyncStartTime := time.Now() wallet, err := NewWalletFromURI(ctx, LocalAPIURI, kc) if err != nil { fmt.Printf("failed to initialize wallet with: %s\n", err) return } fmt.Printf("synced wallet in %s\n", time.Since(walletSyncStartTime)) // Get the P-chain and the X-chain wallets pWallet := wallet.P() xWallet := wallet.X() // Pull out useful constants to use when issuing transactions. xChainID := xWallet.BlockchainID() owner := &secp256k1fx.OutputOwners{ Threshold: 1, Addrs: []ids.ShortID{ genesis.EWOQKey.PublicKey().Address(), }, } // Create a custom asset to send to the P-chain. createAssetStartTime := time.Now() createAssetTxID, err := xWallet.IssueCreateAssetTx( "RnM", "RNM", 9, map[uint32][]verify.State{ 0: { &secp256k1fx.TransferOutput{ Amt: 100 * units.Schmeckle, OutputOwners: *owner, }, }, }, ) if err != nil { fmt.Printf("failed to create new X-chain asset with: %s\n", err) return } fmt.Printf("created X-chain asset %s in %s\n", createAssetTxID, time.Since(createAssetStartTime)) // Send 100 schmeckles to the P-chain. exportStartTime := time.Now() exportTxID, err := xWallet.IssueExportTx( constants.PlatformChainID, []*avax.TransferableOutput{ { Asset: avax.Asset{ ID: createAssetTxID, }, Out: &secp256k1fx.TransferOutput{ Amt: 100 * units.Schmeckle, OutputOwners: *owner, }, }, }, ) if err != nil { fmt.Printf("failed to issue X->P export transaction with: %s\n", err) return } fmt.Printf("issued X->P export %s in %s\n", exportTxID, time.Since(exportStartTime)) // Import the 100 schmeckles from the X-chain into the P-chain. importStartTime := time.Now() importTxID, err := pWallet.IssueImportTx(xChainID, owner) if err != nil { fmt.Printf("failed to issue X->P import transaction with: %s\n", err) return } fmt.Printf("issued X->P import %s in %s\n", importTxID, time.Since(importStartTime)) // Send 100 schmeckles back to the X-chain. exportStartTime = time.Now() exportTxID, err = pWallet.IssueExportTx( xChainID, []*avax.TransferableOutput{ { Asset: avax.Asset{ ID: createAssetTxID, }, Out: &secp256k1fx.TransferOutput{ Amt: 100 * units.Schmeckle, OutputOwners: *owner, }, }, }, ) if err != nil { fmt.Printf("failed to issue P->X export transaction with: %s\n", err) return } fmt.Printf("issued P->X export %s in %s\n", exportTxID, time.Since(exportStartTime)) // Import the 100 schmeckles from the P-chain into the X-chain. importStartTime = time.Now() importTxID, err = xWallet.IssueImportTx(constants.PlatformChainID, owner) if err != nil { fmt.Printf("failed to issue P->X import transaction with: %s\n", err) return } fmt.Printf("issued P->X import %s in %s\n", importTxID, time.Since(importStartTime))
Output:
func NewWalletFromURI ¶
NewWalletFromURI returns a wallet that supports issuing transactions to the chains living in the primary network to a provided [uri].
On creation, the wallet attaches to the provided [uri] and fetches all UTXOs that reference any of the keys contained in [kc]. If the UTXOs are modified through an external issuance process, such as another instance of the wallet, the UTXOs may become out of sync.
The wallet manages all UTXOs locally, and performs all tx signing locally.
func NewWalletWithOptions ¶
Creates a Wallet with the given set of options
func NewWalletWithState ¶
func NewWalletWithState( uri string, pCTX p.Context, xCTX x.Context, utxos UTXOs, kc *secp256k1fx.Keychain, ) Wallet
Creates a wallet with pre-fetched state.