Skip to content
TypeScript/AssemblyScript library for writing mappings for The Graph
TypeScript JavaScript
Branch: master
Clone or download
leoyvens Fix error message in assert
It says `u32` when we're converting to `i32`.
Latest commit 4d53da0 Dec 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
global global: Update to the latest AssemblyScript Dec 7, 2018
test split tests into two files Oct 29, 2019
.gitignore Initial commit Oct 1, 2018
.prettierrc.json
.travis.yml travis: Add CI Oct 18, 2018
LICENSE-APACHE Initial import Oct 1, 2018
LICENSE-MIT Initial import Oct 1, 2018
README.md
helper-functions.ts helper-functions, index: Format with Prettier May 15, 2019
index.ts Fix error message in assert Dec 2, 2019
package.json 0.16.0 Nov 1, 2019
tsconfig.json TypeScript: Fix path to AssemblyScript tsconfig.json Nov 1, 2018
yarn.lock build(deps-dev): bump glob from 7.1.5 to 7.1.6 Dec 2, 2019

README.md

The Graph TypeScript Library (graph-ts)

npm (scoped) Build Status

TypeScript/AssemblyScript library for writing subgraph mappings to be deployed to The Graph.

Usage

For a detailed guide on how to create a subgraph, please see the Graph CLI docs.

One step of creating the subgraph is writing mappings that will process blockchain events and will write entities into the store. These mappings are written in TypeScript/AssemblyScript.

The graph-ts library provides APIs to access the Graph Node store, blockchain data, smart contracts, data on IPFS, cryptographic functions and more. To use it, all you have to do is add a dependency on it:

npm install --dev @graphprotocol/graph-ts # NPM
yarn add --dev @graphprotocol/graph-ts    # Yarn

After that, you can import the store API and other features from this library in your mappings. A few examples:

import { store, crypto } from '@graphprotocol/graph-ts'

// This is just an example event type generated by `graph-cli`
// from an Ethereum smart contract ABI
import { NameRegistered } from './types/abis/SomeContract'

// This is an example of an entity type generated from a
// subgraph's GraphQL schema
import { Domain } from './types/schema'

function handleNameRegistered(event: NameRegistered) {
  // Example use of a crypto function
  let id = crypto.keccak256(name).toHexString()

  // Example use of the generated `Entry` class
  let domain = new Domain()
  domain.name = name
  domain.owner = event.params.owner
  domain.timeRegistered = event.block.timestamp

  // Example use of the store API
  store.set('Name', id, entity)
}

Helper Functions for AssemblyScript

Refer to the helper-functions.ts file in this repository for a few common functions that help build on top of the AssemblyScript library, such as byte array concatenation, among others.

API

Documentation on the API can be found here.

For examples of graph-ts in use take a look at one of the following subgraphs:

License

Copyright © 2018 Graph Protocol, Inc. and contributors.

The Graph TypeScript library is dual-licensed under the MIT license and the Apache License, Version 2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

You can’t perform that action at this time.