@tacoinfra/get-tez
v1.0.8
Published
Programmatic script to get Tezos from faucet
Downloads
24
Readme
get-tez
This zero dependency package provides a programmatic interface to interact with the Tezos faucet. It is a script that can be run from a JavaScript/Typescript program or directly from a shell. Your NodeJS version should support the fetch
api.
Installation
You can install the package from npm:
npm install @tacoinfra/get-tez
Usage
JS / TS
After installing the package, you can import it in your Node.js JavaScript or TypeScript project:
const getTez = require("@tacoinfra/get-tez")
// OR
import getTez from "@tacoinfra/get-tez"
You can then use the getTez
function to interact with the Tezos faucet. The function takes an object as an argument, with the following properties:
address
: The address to send Tez to. This can be a raw Tezos public key hash or a local address's alias.amount
: The amount of Tez to request.network
: The faucet's network name. Must match a network name with a faucet listed at https://teztnets.com. Ignored iffaucetUrl
is set.faucetUrl
: The custom faucet URL. Ignoresnetwork
.clientDir
: (Optional) Specifies a custom client directory path to look up an address alias. If not set, it will default to$HOME/.tezos-client/
or$TEZOS_CLIENT_DIR
if theTEZOS_CLIENT_DIR
environment variable is set.
Here is an example of how to use the getTez
function:
const txHash = await getTez({
address: "tz1...",
amount: 10,
network: "ghostnet",
})
// txHash: ooaEskbj...
Using an address alias:
const txHash = await getTez({
address: "alice",
amount: 10,
network: "ghostnet",
})
// txHash: ooaEskbj...
Example using the faucetUrl
parameter:
const txHash = await getTez({
address: "tz1...",
amount: 10,
faucetUrl: "https://my-custom-faucet-url.com",
})
// txHash: ooaEskbj...
CLI
You can also run get-tez
directly from the command line with npx
:
npx @tacoinfra/get-tez tz1... --amount 10 --network ghostnet
Run the script with the --help
flag for more information.