0.4.1 • Published 2 years ago

@metaplex-foundation/beet-solana v0.4.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 years ago

@metaplex-foundation/beet-solana

Solana specific extension for beet, the borsh compatible de/serializer

API

Please find the API docs here.

GPA Builders

solana-beet uses beets knowledge about account layouts to provide GpaBuilders for them which allow to filter by account data size and content.

  1. Create a GPA Builder via const gpaBuilder = GpaBuilder.fromStruct(programId, accountStruct)
  2. add filters via gpaBuilder.dataSize, gpaBuilder.addFilter or gpaBuilder.addInnerFilter
  3. execute gpaBuilder.run(connection) which will return all accounts matching the specified filters

Examples

Simple struct with primitives

export type ResultsArgs = Pick<Results, 'win' | 'totalWin' | 'losses'>
export class Results {
  constructor(
    readonly win: number,
    readonly totalWin: number,
    readonly losses: number
  ) {}

  static readonly struct = new BeetStruct<Results, ResultsArgs>(
    [
      ['win', u8],
      ['totalWin', u16],
      ['losses', i32],
    ],
    (args: ResultsArgs) => new Results(args.win!, args.totalWin!, args.losses!),
    'Results'
  )
}

const gpaBuilder = GpaBuilder.fromStruct(PROGRAM_ID, Results.struct)
const accounts = await gpaBuilder
  .addFilter('totalWin', 8)
  .addFilter('losses', -7)
  .run()

Matching on Complete Nested Struct

Using Results struct from above

export type TraderArgs = Pick<Trader, 'name' | 'results' | 'age'>
export class Trader {
  constructor(
    readonly name: string,
    readonly results: Results,
    readonly age: number
  ) {}

  static readonly struct = new BeetStruct<Trader, TraderArgs>(
    [
      ['name', fixedSizeUtf8String(4)],
      ['results', Results.struct],
      ['age', u8],
    ],
    (args) => new Trader(args.name!, args.results!, args.age!),
    'Trader'
  )
}

const gpaBuilder = GpaBuilder.fromStruct<Trader>(
  PROGRAM_ID,
  Trader.struct
)

const results = {
  win: 3,
  totalWin: 4,
  losses: -100,
}

const accounts = await gpaBuilder.addFilter('results', results).run()

Matching on Part of Nested Struct

Using Trader struct from above

const gpaBuilder = GpaBuilder.fromStruct<Trader>(
  PROGRAM_ID,
  Trader.struct
)

const account = await gpaBuilder
  .addInnerFilter('results.totalWin', 8)
  .addInnerFilter('results.win', 2)
  .run()

PublicKey

solana-beet provides a de/serializer for solana public keys. They can either be used directly or as part of a struct.

Examples

Using PublicKey Directly

import { publicKey } from '@metaplex-foundation/beet-solana'

const generatedKey  = Keypair.generate().publicKey
const buf = Buffer.alloc(publicKey.byteSize)
beet.write(buf, 0, generatedKey)
beet.read(buf, 0) // same as generatedKey

PublicKey as part of a Struct Configuration

import * as web3 from '@solana/web3.js'
import * as beet from '@metaplex-foundation/beet'
import * as beetSolana from '@metaplex-foundation/beet-solana'

type InstructionArgs = {
  authority: web3.PublicKey
}

const createStruct = new beet.BeetArgsStruct<InstructionArgs>(
  [
    ['authority', beetSolana.publicKey]
  ],
  'InstructionArgs'
)

LICENSE

Apache-2.0

rainfi-cli-testrainfi-test@flxxyz-foundation/js@holaplex/mpl-listing-rewards@holaplex/mpl-reward-center@layerzerolabs/layerzero-v2-solana-sdk@everything-registry/sub-chunk-597w3poker-solana-nft@code-wallet/programs@cryowar/escrow-program-interface@colosseum-so/colosseum-promo-sdk@cosimo-rip/js@blockpal/guild-vault-sdktoken-metadata-descriptor@altruism-finance/js@arrangedev/trusts-sdk@appliedblockchain/metaplex-js@avingoyal01/portfolio-plugins@agreewe-dev/solana-blockchain-contracts@agreewe/solana-blockchain-contracts@albus-finance/sdk@albus-finance/swap-sdk@blockpal/vault-x-sdk@cardinal/mpl-candy-machine-utils@0xmukesh/squad-multisig@2112-labs/emerald-react@2112-labs/emerald.js@0xbanana/js@guakamoli/js@fluidchains/ywpl-token-metadata@fluidchains/ywpl-token-vault@honeycomb-protocol/events@honeycomb-protocol/hive-control@honeycomb-protocol/solita@holaplex/hpl-reward-center@holaplex/mpl-auction-house@genesysgo/ssc-fusion@genesysgo/trait-escrow@glasseaters/hydra-sdk@layerzerolabs/lz-solana-sdk-v2@layerzerolabs/oft-v2-solana-sdk@lorisleiva/mpl-candy-guard@lorisleiva/mpl-candy-machine-core@lorisleiva/mpl-fair-launch@loris-sandbox/mx-monorepo-js@lorisleiva/js-next-alpha@magiceden-oss/open_creator_protocol@magicblock-labs/soar-sdk@magicblock-labs/bolt-sdk@motleylabs/mtly-auction-house@motleylabs/mtly-reward-center@faircrypto/multisig@mimo-capital/blockchain-api@metaplex-foundation/js-next@metaplex-foundation/mpl-auction-house@metaplex-foundation/mpl-auctioneer@metaplex-foundation/mpl-candy-guard@metaplex-foundation/mpl-candy-machine-core@metaplex-foundation/mpl-fixed-price-sale@metaplex-foundation/mpl-gumdrop@metaplex-foundation/mpl-membership-token@metaplex-foundation/mpl-migration-validator@metaplex-foundation/mpl-nft-packs@metaplex-foundation/mpl-token-entangler@metaplex-foundation/solita@jolders/mpl-auction-house@ju-protocol/ju-core@rainfi/sdk@rainfi/rain@rainfi/rain-cli@reclaimprotocol/solana-sdk@onsol/tldparser@onsol/tldsolve@phantasia/nft-store-interface@phantasia/blockchain-interface@noxal/mpl-auction-house@render-foundation/multisigmpl-triflemetapass-sdkmyrandompackagetest7799sequiilloseaway-sdkpixels-on-chain-solanarestake-tsreflect-sdkquisquibusdamsolana-frameworksolaplexsolaplex-foundationsolaplex1soar_sdkglaicon-nft-packshydra-sdk-anchorproviderkyzr-auction-house@tumi-labs/liquidprop@tumi-labs/zar@undergroundsociety/raffle@usedispatch/forum_broadcastairmoney-sdkam-other-sdk
0.4.1

2 years ago

0.4.0

3 years ago

0.3.1

3 years ago

0.3.0

3 years ago

0.2.0

3 years ago

0.1.0

3 years ago

0.1.1

3 years ago

0.0.6

3 years ago

0.0.5

3 years ago

0.0.4

3 years ago

0.0.3

3 years ago

0.0.2

3 years ago

0.0.1

4 years ago

0.0.0

4 years ago