Skip to content

QUICKSTART.md

Latest commit

 

History

History
211 lines (139 loc) · 4.71 KB

QUICKSTART.md

File metadata and controls

211 lines (139 loc) · 4.71 KB

Faremeter Quickstart

Here's a quick way to get the Faremeter tooling up and running. The following will:

  • Setup a test environment using Faremeter infrastructure
  • Use devnet for Solana transactions and Base Sepolia for EVM transactions
  • Use the experimental @faremeter/x-solana-settlement payment scheme for Solana
  • Use EIP-3009 gasless USDC transfers for EVM payments

For more information, see the developer notes.

From inside the faremeter git repository, run the following:

0. Install tooling

Install developer tooling:

NOTE: These tools may also be available from your favorite package manager (e.g. Homebrew.

1. Setup your environment

git config core.hooksPath .githooks
pnpm install -r
solana config set -u devnet
make

2. Generate keypairs/wallets

For Solana

  • Payer
  • PayTo
  • Admin (responsible for settling the transaction).
mkdir keypairs
solana-keygen new --no-bip39-passphrase -o keypairs/payer.json
solana-keygen new --no-bip39-passphrase -o keypairs/payto.json
solana-keygen new --no-bip39-passphrase -o keypairs/admin.json

For EVM

Generate EVM private keys for testing:

# Generate a new EVM wallet
(cd scripts && pnpm tsx evm-example/gen-wallet.ts)

# Save the generated private key and address for use in step 4

3. Fund your wallets

For Solana

Fund all keypairs with SOL and USDC on devnet:

For EVM

Fund your Base Sepolia wallets:

4. Setup the configuration

Solana Configuration

cat > apps/facilitator/.env <<EOF
ADMIN_KEYPAIR_PATH=../../keypairs/admin.json
EOF

cat > scripts/.env <<EOF
PAYER_KEYPAIR_PATH=../keypairs/payer.json
PAYTO_KEYPAIR_PATH=../keypairs/payto.json
EOF

EVM Configuration

To enable EVM support for Base Sepolia USDC payments:

# Add to apps/facilitator/.env
cat >> apps/facilitator/.env <<EOF
EVM_PRIVATE_KEY=0xYOUR_FACILITATOR_PRIVATE_KEY_HERE
EOF

# Add to scripts/.env
cat >> scripts/.env <<EOF
EVM_PRIVATE_KEY=0xYOUR_CLIENT_PRIVATE_KEY_HERE
EOF

NOTE: For EVM payments, you'll need:

  • USDC tokens on Base Sepolia in your client wallet for making payments
  • ETH on Base Sepolia in your facilitator wallet for paying gas fees
  • EVM_PRIVATE_KEY is required for the facilitator

5. Start the facilitator

In a separate terminal, run:

(cd apps/facilitator && pnpm tsx src )

6. Start the resource server

In a separate terminal, run:

For Solana payments:

(cd scripts && pnpm tsx solana-example/server-express.ts)

For EVM payments:

(cd scripts && pnpm tsx evm-example/server-express.ts)

7. Run a test client

Solana Payments

Sol Payment Using Local Keypair

In a separate terminal, run:

(cd scripts && pnpm tsx solana-example/sol-payment.ts)

Native Sol Payment Directly via Squads Smart Wallet

You may also run a payment using Squads:

(cd scripts && pnpm tsx solana-example/squads-payment.ts)

Native Sol Payment via Crossmint API

Or pay using the Crossmint wallet:

(cd scripts && pnpm tsx solana-example/crossmint-payment.ts)

NOTE: To pay using Crossmint, you must have your CROSSMINT_WALLET address and CROSSMINT_API_KEY in your dotenv or environment. Your Crossmint wallet should be a Smart Wallet and you should use your server API key.

Pay using an SPL Token Using Local Keypair

(cd scripts && pnpm tsx solana-example/token-payment.ts)

NOTE: Your payer keypair must be funded with SPL Token-based USDC for this demo to work.

EVM Payments

USDC Payment on Base Sepolia

Using EIP-3009 gasless transfers (client signs, facilitator pays gas):

(cd scripts && pnpm tsx evm-example/base-sepolia-payment.ts)

You can also specify a custom port and endpoint:

(cd scripts && pnpm tsx evm-example/base-sepolia-payment.ts 4021 premium/content)

NOTE: Your client wallet must be funded with USDC on Base Sepolia for this to work.

Result

For Solana payments, you should see:

{ "msg": "success" }

For EVM payments, you should see:

{
  "temperature": 72,
  "conditions": "sunny",
  "message": "Thanks for your payment!"
}

... as the client output. At the same time, the facilitator will log the processing of the payment.