diff --git a/.github/workflows/beet-solana.yml b/.github/workflows/beet-bbachain.yml similarity index 90% rename from .github/workflows/beet-solana.yml rename to .github/workflows/beet-bbachain.yml index b57e745..e5aa830 100644 --- a/.github/workflows/beet-solana.yml +++ b/.github/workflows/beet-bbachain.yml @@ -1,4 +1,4 @@ -name: Build Lint and Test Beet Solana +name: Build Lint and Test Beet BBAChain on: push: @@ -32,7 +32,7 @@ jobs: yarn run build - name: yarn build, lint and test - working-directory: ./beet-solana + working-directory: ./beet-bbachain run: | yarn run build yarn run lint diff --git a/README.md b/README.md index 8719ae6..a72499f 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@ ## Packages - [beet](./beet) primitive, collections and composite de/serializers as well as _beet_ struct - configurations | [API docs](https://metaplex-foundation.github.io/beet/docs/beet) -- [beet-solana](./beet-solana) solana specific _beet_ de/serializers | [API docs](https://metaplex-foundation.github.io/beet/docs/beet-solana) + configurations | [API docs](https://bbachain.github.io/beet/docs/beet) +- [beet-bbachain](./beet-bbachain) bbachain specific _beet_ de/serializers | [API docs](https://bbachain.github.io/beet/docs/beet-bbachain) ## LICENSE diff --git a/beet-solana/.prettierrc b/beet-bbachain/.prettierrc similarity index 100% rename from beet-solana/.prettierrc rename to beet-bbachain/.prettierrc diff --git a/beet-solana/LICENSE b/beet-bbachain/LICENSE similarity index 100% rename from beet-solana/LICENSE rename to beet-bbachain/LICENSE diff --git a/beet-solana/README.md b/beet-bbachain/README.md similarity index 81% rename from beet-solana/README.md rename to beet-bbachain/README.md index ba6dad5..2d0d5ff 100644 --- a/beet-solana/README.md +++ b/beet-bbachain/README.md @@ -1,14 +1,14 @@ -# @metaplex-foundation/beet-solana +# @bbachain/beet-bbachain -Solana specific extension for beet, the borsh compatible de/serializer +BBAChain specific extension for beet, the borsh compatible de/serializer ## API -Please find the [API docs here](https://metaplex-foundation.github.io/beet/docs/beet-solana). +Please find the [API docs here](https://bbachain.github.io/beet/docs/beet-bbachain). ## GPA Builders -solana-beet uses `beet`s knowledge about account layouts to provide `GpaBuilder`s for +bbachain-beet uses `beet`s knowledge about account layouts to provide `GpaBuilder`s for them which allow to filter by account data size and content. 1. Create a GPA Builder via `const gpaBuilder = GpaBuilder.fromStruct(programId, accountStruct)` @@ -103,7 +103,7 @@ const account = await gpaBuilder ## PublicKey -solana-beet provides a de/serializer for solana public keys. +beet-bbachain provides a de/serializer for bbachain public keys. They can either be used directly or as part of a struct. ### Examples @@ -111,7 +111,7 @@ They can either be used directly or as part of a struct. #### Using PublicKey Directly ```ts -import { publicKey } from '@metaplex-foundation/beet-solana' +import { publicKey } from '@bbachain/beet-bbachain' const generatedKey = Keypair.generate().publicKey const buf = Buffer.alloc(publicKey.byteSize) @@ -122,9 +122,9 @@ beet.read(buf, 0) // same as generatedKey #### PublicKey as part of a Struct Configuration ```ts -import * as web3 from '@solana/web3.js' -import * as beet from '@metaplex-foundation/beet' -import * as beetSolana from '@metaplex-foundation/beet-solana' +import * as beet from '@bbachain/beet' +import * as beetBBA from '@bbachain/beet-bbachain' +import * as web3 from '@bbachain/web3.js' type InstructionArgs = { authority: web3.PublicKey @@ -132,7 +132,7 @@ type InstructionArgs = { const createStruct = new beet.BeetArgsStruct( [ - ['authority', beetSolana.publicKey] + ['authority', beetBBA.publicKey] ], 'InstructionArgs' ) diff --git a/beet-solana/package.json b/beet-bbachain/package.json similarity index 68% rename from beet-solana/package.json rename to beet-bbachain/package.json index 3f92d3d..e4e69a9 100644 --- a/beet-solana/package.json +++ b/beet-bbachain/package.json @@ -1,10 +1,10 @@ { - "name": "@metaplex-foundation/beet-solana", - "version": "0.4.1", - "description": "Solana specific extension for beet, the borsh compatible de/serializer", + "name": "@bbachain/beet-bbachain", + "version": "0.0.1", + "description": "BBAChain specific extension for beet, the borsh compatible de/serializer", "sideEffects": false, - "main": "dist/cjs/src/beet-solana.js", - "types": "dist/types/src/beet-solana.d.ts", + "main": "dist/cjs/src/beet-bbachain.js", + "types": "dist/types/src/beet-bbachain.d.ts", "scripts": { "check:publish-ready": "yarn build && yarn test", "preversion": "yarn check:publish-ready", @@ -16,10 +16,10 @@ "test": "tape dist/cjs/test/*.js", "lint": "prettier -c ./src/", "lint:fix": "prettier --write ./src", - "doc": "rimraf ../docs/beet-solana && typedoc" + "doc": "rimraf ../docs/beet-bbachain && typedoc" }, - "repository": "git@github.com:metaplex-foundation/beet-solana.git", - "author": "Thorsten Lorenz ", + "repository": "git@github.com:bbachain/beet.git", + "author": "BBAChain Labs ", "license": "Apache-2.0", "directories": { "dist": "./dist/src" @@ -29,10 +29,11 @@ "dist/types/src/*" ], "dependencies": { - "@metaplex-foundation/beet": ">=0.1.0", - "@solana/web3.js": "^1.56.2", + "@bbachain/beet": ">=0.0.0", + "@bbachain/web3.js": "^1.1.3", "bs58": "^5.0.0", - "debug": "^4.3.4" + "debug": "^4.3.4", + "rpc-websockets": "7.11.0" }, "devDependencies": { "@types/debug": "^4.1.7", diff --git a/beet-solana/src/beet-solana.ts b/beet-bbachain/src/beet-bbachain.ts similarity index 59% rename from beet-solana/src/beet-solana.ts rename to beet-bbachain/src/beet-bbachain.ts index 4a2cb5f..f55ddd6 100644 --- a/beet-solana/src/beet-solana.ts +++ b/beet-bbachain/src/beet-bbachain.ts @@ -1,4 +1,4 @@ -import { SupportedTypeDefinition } from '@metaplex-foundation/beet' +import { SupportedTypeDefinition } from '@bbachain/beet' import { KeysExports, keysTypeMap, KeysTypeMapKey } from './keys' export * from './keys' @@ -7,22 +7,22 @@ export * from './gpa' /** * @category TypeDefinition */ -export type BeetSolanaTypeMapKey = KeysTypeMapKey +export type BeetBBAChainTypeMapKey = KeysTypeMapKey /** * @category TypeDefinition */ -export type BeetSolanaExports = KeysExports +export type BeetBBAChainExports = KeysExports /** - * Maps solana beet exports to metadata which describes in which package it + * Maps bbachain beet exports to metadata which describes in which package it * is defined as well as which TypeScript type is used to represent the * deserialized value in JavaScript. * * @category TypeDefinition */ export const supportedTypeMap: Record< - BeetSolanaTypeMapKey, + BeetBBAChainTypeMapKey, SupportedTypeDefinition & { - beet: BeetSolanaExports + beet: BeetBBAChainExports } > = keysTypeMap diff --git a/beet-solana/src/gpa/index.ts b/beet-bbachain/src/gpa/index.ts similarity index 99% rename from beet-solana/src/gpa/index.ts rename to beet-bbachain/src/gpa/index.ts index bc2e370..b5f84a2 100644 --- a/beet-solana/src/gpa/index.ts +++ b/beet-bbachain/src/gpa/index.ts @@ -5,13 +5,13 @@ import { FixableBeetStruct, FixedSizeBeet, isFixedSizeBeet, -} from '@metaplex-foundation/beet' +} from '@bbachain/beet' import { Connection, GetProgramAccountsConfig, GetProgramAccountsFilter, PublicKey, -} from '@solana/web3.js' +} from '@bbachain/web3.js' import { strict as assert } from 'assert' import { logTrace } from '../utils' import { encodeFixedBeet } from './util' diff --git a/beet-solana/src/gpa/util.ts b/beet-bbachain/src/gpa/util.ts similarity index 76% rename from beet-solana/src/gpa/util.ts rename to beet-bbachain/src/gpa/util.ts index e0666b0..afe33fb 100644 --- a/beet-solana/src/gpa/util.ts +++ b/beet-bbachain/src/gpa/util.ts @@ -1,4 +1,4 @@ -import { FixedSizeBeet } from '@metaplex-foundation/beet' +import { FixedSizeBeet } from '@bbachain/beet' import base58 from 'bs58' export function encodeFixedBeet(beet: FixedSizeBeet, val: T) { diff --git a/beet-solana/src/keys.ts b/beet-bbachain/src/keys.ts similarity index 75% rename from beet-solana/src/keys.ts rename to beet-bbachain/src/keys.ts index 550834d..9926ff8 100644 --- a/beet-solana/src/keys.ts +++ b/beet-bbachain/src/keys.ts @@ -1,22 +1,22 @@ -import { PublicKey } from '@solana/web3.js' +import { PublicKey } from '@bbachain/web3.js' import { FixedSizeBeet, fixedSizeUint8Array, SupportedTypeDefinition, -} from '@metaplex-foundation/beet' -const BEET_SOLANA_PACKAGE = '@metaplex-foundation/beet-solana' -const SOLANA_WEB3_PACKAGE = '@solana/web3.js' +} from '@bbachain/beet' +const BEET_BBACHAIN_PACKAGE = '@bbachain/beet-bbachain' +const BBACHAIN_WEB3_PACKAGE = '@bbachain/web3.js' const uint8Array32 = fixedSizeUint8Array(32) /** - * De/Serializer for solana {@link PublicKey}s aka `publicKey`. + * De/Serializer for bbachain {@link PublicKey}s aka `publicKey`. * * * ## Using PublicKey Directly * * ```ts - * import { publicKey } from '@metaplex-foundation/beet-solana' + * import { publicKey } from '@bbachain/beet-bbachain' * * const generatedKey = Keypair.generate().publicKey * const buf = Buffer.alloc(publicKey.byteSize) @@ -27,7 +27,7 @@ const uint8Array32 = fixedSizeUint8Array(32) * ## PublicKey as part of a Struct Configuration * * ```ts - * import { publicKey } from '@metaplex-foundation/beet-solana' + * import { publicKey } from '@bbachain/beet-bbachain' * * type InstructionArgs = { * authority: web3.PublicKey @@ -41,7 +41,7 @@ const uint8Array32 = fixedSizeUint8Array(32) * ) * ``` * - * @category beet/solana + * @category beet/bbachain */ export const publicKey: FixedSizeBeet = { write: function (buf: Buffer, offset: number, value: PublicKey): void { @@ -74,7 +74,7 @@ export type KeysTypeMap = Record< > /** - * Maps solana keys beet exports to metadata which describes in which package it + * Maps bbachain keys beet exports to metadata which describes in which package it * is defined as well as which TypeScript type is used to represent the * deserialized value in JavaScript. * @@ -84,8 +84,8 @@ export const keysTypeMap: KeysTypeMap = { publicKey: { beet: 'publicKey', isFixable: false, - sourcePack: BEET_SOLANA_PACKAGE, + sourcePack: BEET_BBACHAIN_PACKAGE, ts: 'PublicKey', - pack: SOLANA_WEB3_PACKAGE, + pack: BBACHAIN_WEB3_PACKAGE, }, } diff --git a/beet-solana/src/utils.ts b/beet-bbachain/src/utils.ts similarity index 100% rename from beet-solana/src/utils.ts rename to beet-bbachain/src/utils.ts diff --git a/beet-solana/test/gpa.nested.ts b/beet-bbachain/test/gpa.nested.ts similarity index 98% rename from beet-solana/test/gpa.nested.ts rename to beet-bbachain/test/gpa.nested.ts index d7b6c7f..37bbfde 100644 --- a/beet-solana/test/gpa.nested.ts +++ b/beet-bbachain/test/gpa.nested.ts @@ -8,7 +8,7 @@ import { Trader, withDecodedBytes, } from './utils' -import { GpaBuilder } from '../src/beet-solana' +import { GpaBuilder } from '../src/beet-bbachain' test('gpa: fixed struct nested inside fixed struct', (t) => { let gpaBuilder: GpaBuilder = GpaBuilder.fromStruct( diff --git a/beet-solana/test/gpa.ts b/beet-bbachain/test/gpa.ts similarity index 96% rename from beet-solana/test/gpa.ts rename to beet-bbachain/test/gpa.ts index 6bac6d5..510f58b 100644 --- a/beet-solana/test/gpa.ts +++ b/beet-bbachain/test/gpa.ts @@ -1,7 +1,7 @@ import test from 'tape' import spok from 'spok' -import { BeetStruct } from '@metaplex-foundation/beet' -import { u8 } from '@metaplex-foundation/beet' +import { BeetStruct } from '@bbachain/beet' +import { u8 } from '@bbachain/beet' import { IntAndString, PROGRAM_ID, @@ -9,7 +9,7 @@ import { stringFilter, withDecodedBytes, } from './utils' -import { GpaBuilder } from '../src/beet-solana' +import { GpaBuilder } from '../src/beet-bbachain' test('gpa: fixed struct with one u8', (t) => { type Args = { diff --git a/beet-solana/test/keys.public.ts b/beet-bbachain/test/keys.public.ts similarity index 86% rename from beet-solana/test/keys.public.ts rename to beet-bbachain/test/keys.public.ts index eebc49d..87df598 100644 --- a/beet-solana/test/keys.public.ts +++ b/beet-bbachain/test/keys.public.ts @@ -1,6 +1,6 @@ -import { FixedSizeBeet } from '@metaplex-foundation/beet' -import { PublicKey, Keypair } from '@solana/web3.js' -import { publicKey } from '../src/beet-solana' +import { FixedSizeBeet } from '@bbachain/beet' +import { PublicKey, Keypair } from '@bbachain/web3.js' +import { publicKey } from '../src/beet-bbachain' import test from 'tape' function checkCases( diff --git a/beet-solana/test/utils/index.ts b/beet-bbachain/test/utils/index.ts similarity index 98% rename from beet-solana/test/utils/index.ts rename to beet-bbachain/test/utils/index.ts index 05a4aef..890ae40 100644 --- a/beet-solana/test/utils/index.ts +++ b/beet-bbachain/test/utils/index.ts @@ -6,13 +6,13 @@ import { u16, u8, utf8String, -} from '@metaplex-foundation/beet' +} from '@bbachain/beet' import { GetProgramAccountsConfig, GetProgramAccountsFilter, MemcmpFilter, PublicKey, -} from '@solana/web3.js' +} from '@bbachain/web3.js' import base58 from 'bs58' import * as util from 'util' diff --git a/beet-solana/tsconfig.json b/beet-bbachain/tsconfig.json similarity index 100% rename from beet-solana/tsconfig.json rename to beet-bbachain/tsconfig.json diff --git a/beet-solana/typedoc.json b/beet-bbachain/typedoc.json similarity index 56% rename from beet-solana/typedoc.json rename to beet-bbachain/typedoc.json index fc18cef..0ec68f8 100644 --- a/beet-solana/typedoc.json +++ b/beet-bbachain/typedoc.json @@ -1,8 +1,8 @@ { - "entryPoints": ["src/beet-solana.ts"], + "entryPoints": ["src/beet-bbachain.ts"], "excludePrivate": true, "categorizeByGroup": false, "readme": "none", "emit": "both", - "out": "../docs/beet-solana" + "out": "../docs/beet-bbachain" } diff --git a/beet/README.md b/beet/README.md index 3de9b26..dd65dd7 100644 --- a/beet/README.md +++ b/beet/README.md @@ -1,4 +1,4 @@ -# @metaplex-foundation/beet +# @bbachain/beet Strict borsh compatible de/serializer. @@ -75,14 +75,14 @@ that processes dynamic types directly use one of the alternatives, i.e. [borsh-j ## API -Please find the [API docs here](https://metaplex-foundation.github.io/beet/docs/beet). +Please find the [API docs here](https://bbachain.github.io/beet/docs/beet). ## Examples ### Single Fixed Struct Configuration ```ts -import { BeetStruct, i32, u16, u8 } from '@metaplex-foundation/beet' +import { BeetStruct, i32, u16, u8 } from '@bbachain/beet' class Result { constructor( @@ -106,7 +106,7 @@ class Result { ### Single Fixable Struct Configuration ```ts -import { FixableBeetStruct, i32, u16, u8, array } from '@metaplex-foundation/beet' +import { FixableBeetStruct, i32, u16, u8, array } from '@bbachain/beet' class Result { constructor( @@ -132,7 +132,7 @@ class Result { **NOTE:** uses `Result` struct from the above example for the `results` field of `Trader` ```ts -import { BeetStruct, fixedSizeUtf8String } from '@metaplex-foundation/beet' +import { BeetStruct, fixedSizeUtf8String } from '@bbachain/beet' class Trader { constructor( readonly name: string, @@ -158,12 +158,12 @@ const [deserializedTrader] = Trader.struct.deserialize(buf) ### Struct with non-primitive fields -**NOTE:** depends on `beet-solana` extension package for the `PublicKey` implementation +**NOTE:** depends on `beet-bbachain` extension package for the `PublicKey` implementation ```ts -import * as web3 from '@solana/web3.js' -import * as beet from '@metaplex-foundation/beet' -import * as beetSolana from '@metaplex-foundation/beet-solana' +import * as beet from '@bbachain/beet' +import * as beetBBA from '@bbachain/beet-bbachain' +import * as web3 from '@bbachain/web3.js' type InstructionArgs = { instructionDiscriminator: number[] @@ -175,8 +175,8 @@ type InstructionArgs = { const createStruct = new beet.BeetArgsStruct( [ ['instructionDiscriminator', beet.fixedSizeArray(beet.u8, 8)], - ['authority', beetSolana.publicKey], - ['maybePublickKey', beet.coption(beetSolana.publicKey)], + ['authority', beetBBA.publicKey], + ['maybePublickKey', beet.coption(beetBBA.publicKey)], ], 'InstructionArgs' ) @@ -187,7 +187,7 @@ const createStruct = new beet.BeetArgsStruct( #### Fixed Size ```ts -import { u8 } from '@metaplex-foundation/beet' +import { u8 } from '@bbachain/beet' const n = 1 const buf = Buffer.alloc(u8.byteSize) u8.write(buf, 0, n) @@ -197,7 +197,7 @@ u8.read(buf, 0) // === 1 #### Dynamic Size ```ts -import { u8, array } from '@metaplex-foundation/beet' +import { u8, array } from '@bbachain/beet' const xs = [ 1, 2 ] const beet = array(u8) const fixedBeet = beet.toFixedFromValue(xs) @@ -275,7 +275,7 @@ const collectionInfoBeet = beet.dataEnum([ new beet.FixableBeetArgsStruct( [ ['symbol', beet.utf8String], - ['verifiedCreators', beet.array(beetSolana.publicKey)], + ['verifiedCreators', beet.array(beetBBA.publicKey)], ['whitelistRoot', beet.uniformFixedSizeArray(beet.u8, 32)], ], 'CollectionInfoRecord["V1"]' @@ -285,7 +285,7 @@ const collectionInfoBeet = beet.dataEnum([ [ 'V2', new beet.BeetArgsStruct( - [['collectionMint', beetSolana.publicKey]], + [['collectionMint', beetBBA.publicKey]], 'CollectionInfoRecord["V2"]' ), ], diff --git a/beet/package.json b/beet/package.json index 593083c..64fee8a 100644 --- a/beet/package.json +++ b/beet/package.json @@ -1,5 +1,5 @@ { - "name": "@metaplex-foundation/beet", + "name": "@bbachain/beet", "version": "0.7.2", "description": "Strict borsh compatible de/serializer", "sideEffects": false, @@ -21,8 +21,8 @@ "doc": "rimraf ../docs/beet && typedoc", "doctoc": "doctoc README.md" }, - "repository": "git@github.com:metaplex-foundation/beet.git", - "author": "Thorsten Lorenz ", + "repository": "git@github.com:bbachain/beet.git", + "author": "BBAChain Labs ", "license": "Apache-2.0", "directories": { "dist": "./dist/src" diff --git a/beet/src/types.ts b/beet/src/types.ts index 03869b8..ff0a3ff 100644 --- a/beet/src/types.ts +++ b/beet/src/types.ts @@ -6,7 +6,7 @@ import { strict as assert } from 'assert' * * @private */ -export const BEET_PACKAGE = '@metaplex-foundation/beet' +export const BEET_PACKAGE = '@bbachain/beet' /** * Base Beet type. @@ -194,7 +194,7 @@ export const BEET_TYPE_ARG_INNER = 'Beet<{innner}>' * NOTE: that if this is `false`, the struct is considered _fixed_ size which * means it has the same size no matter what value it holds * @property sourcPack the package where the definition is exported, - * i.e. beet or beet-solana + * i.e. beet or beet-bbachain * @property ts is the TypeScript type representing the deserialized type * @property arg specifies the type of arg to provide to create the Beet type * - len: for fixed size arrays and strings diff --git a/package.json b/package.json index 1899628..3fd4a09 100644 --- a/package.json +++ b/package.json @@ -1,24 +1,24 @@ { "scripts": { - "build": "(cd ./beet && yarn build) && (cd ./beet-solana && yarn build)", + "build": "(cd ./beet && yarn build) && (cd ./beet-bbachain && yarn build)", "postinstall": "patch-package", - "test": "yarn test:beet && yarn test:beet-solana", + "test": "yarn test:beet && yarn test:beet-bbachain", "test:beet": "cd ./beet && yarn test && yarn test:browser", - "test:beet-solana": "cd ./beet-solana && yarn test", - "doc": "(cd ./beet && yarn doc); (cd ./beet-solana && yarn doc)", + "test:beet-bbachain": "cd ./beet-bbachain && yarn test", + "doc": "(cd ./beet && yarn doc); (cd ./beet-bbachain && yarn doc)", "doc:update": "./sh/update-docs", "patch:minipass": "patch-package tap-parser/minipass" }, "workspaces": { "packages": [ "beet", - "beet-solana" + "beet-bbachain" ] }, - "author": "Metaplex Maintainers ", - "homepage": "https://metaplex.com", + "author": "BBAChain Labs ", + "homepage": "https://bbachain.com", "repository": { - "url": "https://github.com/metaplex/beet.git" + "url": "https://github.com/bbachain/beet.git" }, "private": true, "devDependencies": {