Quick Start

The bare minimum steps to take in order to use Tableland.

JavaScript SDK

1. Install the JavaScript SDK using npm:

npm install --save @tableland/sdk

Or yarn:

yarn add @tableland/sdk

2. Import it and use it in your client-side web app:

import { connect } from '@tableland/sdk'

// Establish a connection
const tableland = await connect({ network: "testnet", chain: "polygon-mumbai" });

// Create a table
const { name } = await tableland.create(`id int primary key, name text`, `quickstart`)
// Wait for the table to be created, then query
const writeRes = await tableland.write(`INSERT INTO ${name} VALUES (0, 'Bobby Tables');`
const readRes = await tableland.read(`SELECT * FROM ${name}`)

Note: Node.js support also exists; see the SDK docs for more detailed setup information, including the ethers library.

CLI

1. Install the Tableland CLI using npm:

npm install -g @tableland/cli

or yarn:

yarn add global @tableland/cli

2. And using the CLI, create a table, insert (write) a value (after signing a Sign In With Ethereum token), and read from the newly updated table:

# Create a table & save its returned `name` locally
tableland create "id int primary key, name text" "quickstart" --chain=polygon-mumbai --privateKey "your_private_key_"

# Write to the table by INSERTing a value
# Note: every table `name` is unique, so replace `quickstart_5_74` with your
tableland write "INSERT INTO quickstart_5_74 VALUES (0, 'Bobby Tables')" --chain=polygon-mumbai --privateKey "your_private_key_" --token "siwe_token"

# Read from the table
# Note: replace the table name with yours
# Although, anyone can *read* from *any* table, so this statement is valid for anyone
tableland read "SELECT * FROM quickstart_5_74;" --chain=polygon-mumbai 

Smart Contracts

1. Clone the repo at evm-tableland, which has smart contracts in a hardhat project:

git clone https://github.com/tablelandnetwork/evm-tableland

2. Build the client

npm install
npx hardhat compile
npm run build

3. Start a local hardhat node & deploy the contracts:

# in one terminal, run the following
npx hardhat node

# and in a separate terminal, deploy the contracts
npx hardhat run scripts/deploy.ts --network localhost

• Quick Start
• JavaScript SDK
• CLI
• Smart Contracts