sdk

README

Deltaswap Software Development Kit

This directory contains libraries in various languages for developing software that interacts with deltaswap.

Directory Structure

• sdk/: Go SDK. This package must live in this directory so that clients can use the gitub.com/deltaswapio/deltaswap/sdk import path.
• vaa/: Go package for using VAAs (Verifiable Action Approval).
• js/: Javascript SDK.
• js-proto-node/: NodeJS client protobuf.
• js-proto-web/: Web client protobuf.
• js-wasm/: WebAssembly libraries.
• rust/: Rust SDK.

Documentation

Index

• Variables
• func GetEmitterAddressForChain(chainID vaa.ChainID, emitterType EmitterType) (vaa.Address, error)
• type EmitterInfo
• type EmitterType
  • func (et EmitterType) String() string

Variables

var (
	HeartbeatMessagePrefix = []byte("heartbeat|")

	SignedObservationRequestPrefix_old = []byte("signed_observation_request|")
	SignedObservationRequestPrefix     = []byte("signed_observation_request_000000|")
	SignedDeltachainAddressPrefix      = []byte("signed_deltachain_address_00000000|")
)

var KnownDevnetEmitters = buildKnownEmitters(knownDevnetTokenbridgeEmitters, knownDevnetNFTBridgeEmitters)

KnownDevnetEmitters is a list of known emitters used during development.

var KnownDevnetNFTBridgeEmitters = buildEmitterMap(knownDevnetNFTBridgeEmitters)

KnownDevnetNFTBridgeEmitters is a map of known NFT emitters used during development.

var KnownDevnetTokenbridgeEmitters = buildEmitterMap(knownDevnetTokenbridgeEmitters)

KnownDevnetTokenbridgeEmitters is a map of known tokenbridge emitters used during development.

var KnownEmitters = buildKnownEmitters(knownTokenbridgeEmitters, knownNFTBridgeEmitters)

KnownEmitters is a list of well-known mainnet emitters we want to take into account when iterating over all emitters - like for finding and repairing missing messages.

Deltaswap is not permissioned - anyone can use it. Adding contracts to this list is entirely optional and at the core team's discretion.

var KnownNFTBridgeEmitters = buildEmitterMap(knownNFTBridgeEmitters)

KnownNFTBridgeEmitters is a list of well-known mainnet emitters for the NFT bridge.

var KnownTestnetEmitters = buildKnownEmitters(knownTestnetTokenbridgeEmitters, knownTestnetNFTBridgeEmitters)

KnownTestnetEmitters is a list of known emitters on the various L1 testnets.

var KnownTestnetNFTBridgeEmitters = buildEmitterMap(knownTestnetNFTBridgeEmitters)

KnownTestnetNFTBridgeEmitters is a map of known NFT emitters on the various L1 testnets.

var KnownTestnetTokenbridgeEmitters = buildEmitterMap(knownTestnetTokenbridgeEmitters)

KnownTestnetTokenbridgeEmitters is a map of known tokenbridge emitters on the various L1 testnets.

var KnownTokenbridgeEmitters = buildEmitterMap(knownTokenbridgeEmitters)

KnownTokenbridgeEmitters is a list of well-known mainnet emitters for the tokenbridge.

var PublicRPCEndpoints = []string{
	"https://p-1.deltaswap.io",
	"https://p-2.deltaswap.io",
}

PublicRPCEndpoints is a list of known public RPC endpoints for mainnet, operated by Deltaswap phylax nodes.

This list is duplicated a couple times across the codebase - make to to update all copies!

Functions

func GetEmitterAddressForChain

func GetEmitterAddressForChain(chainID vaa.ChainID, emitterType EmitterType) (vaa.Address, error)

Types

type EmitterInfo

type EmitterInfo struct {
	ChainID    vaa.ChainID
	Emitter    string
	BridgeType EmitterType
}

type EmitterType

type EmitterType uint8

const (
	EmitterTypeUnset   EmitterType = 0
	EmitterCoreBridge  EmitterType = 1
	EmitterTokenBridge EmitterType = 2
	EmitterNFTBridge   EmitterType = 3
)

func (EmitterType) String

func (et EmitterType) String() string